字节里程标准接口文档

Docs
  • index
    • diy页面--接口路径和首页布局一样,只是多带了个参数page_id
    • 商城配置
    • 测试
    • 购买框
    • 首页布局
    • 首页布局_copy
  • 门店
    • 门店列表
    • 门店详情
  • 足迹
    • 商品足迹
    • 我的数据
    • 足迹删除
  • 股东分红--插件
    • 分红明细
    • 升级
    • 升级页面
    • 是否符合要求
    • 查看审核状态|获取股东信息
    • 清除申请信息
    • 申请提现
    • 申请股东
  • N元任选--插件
    • 下单提交
    • 下单预览
    • 凑单池列表
    • 凑单池删除
    • 凑单池添加
    • 凑单池编辑
    • 商品列表
    • 商品详情
    • 海报
  • 套餐组合
    • 套餐详情
    • 套餐配置
    • 活动主页
  • 区域代理--插件
    • 判断区域代理状态
    • 是否符合要求
    • 申请代理
    • 申请升级
    • 获取设置
  • 电子卡密
    • 卡密使用说明
    • 电子卡密列表
  • 社区团购--插件
    • 提货通知
    • 下单提交
    • 分享海报数据获取
    • 利润提现
    • 利润提现列表
    • 利润提现配置
    • 商品海报获取
    • 商品详情
    • 团长信息修改
    • 团长列表
    • 团长利润列表
    • 团长利润详情
    • 团长活动列表
    • 团长活动数据
    • 团长活动详情
    • 团长订单列表
    • 团长订单详情
    • 下单预览
    • 活动商品开关
    • 活动海报
    • 添加购物车
    • 用户活动详情
    • 申请成为团长
    • 申请结果
    • 绑定团长
    • 获取团长信息
    • 获取支付id
    • 订单列表
    • 订单详情
    • 设置
    • 购物车列表
    • 购物车删除
    • 购物车批量编辑
    • 购物车添加结果
  • 限时抢购
    • 加入购物车
    • 商品详情
    • 活动列表
  • 商品批发
    • 商品列表
    • 商品详情
    • 下单预览
    • 下单提交
  • 海报
    • 专题海报
    • 合伙人海报
    • 商品海报
  • 签到
    • 用户设置
    • 自定义数据
    • 获取签到日期
    • 配置
    • 领取奖励
    • 领取奖励结果
  • 九宫格--抽奖
    • 海报
    • 抽奖
    • 活动列表
    • 活动记录
    • 活动详情
    • 新增/编辑活动
    • 订单提交
    • 订单预览
    • 记录
    • 配置
    • 首页
  • 刮刮卡--插件
    • 订单提交
    • 中奖名单数据
    • 活动列表
    • 活动数据
    • 添加/编辑活动
    • 刮刮卡海报
    • 订单预览
    • 记录
    • 配置
    • 领取奖品
    • 首页
  • 幸运抽奖--插件
    • 商品详情
    • 奖品记录
    • 奖品详情
    • 幸运码
    • 海报
    • 订单提交
    • 订单预览
    • 邀请机会
    • 配置
    • 首页
  • 预约--插件
    • 预约商品列表
    • 预约商品详情
    • 订单预览
    • 订单提交
    • 分类列表
    • 门店列表
    • 配置详情
    • 预约订单列表
    • 预约订单详情
    • 预约核销码
    • 预约申请取消
  • 拼团--插件
    • 我的拼团列表
    • 拼团下单
    • 拼团分类列表
    • 拼团商品列表
    • 拼团商品详情
    • 拼团详情
    • 拼团首页
  • 秒杀--插件
    • 秒杀商品分类列表(未使用)
    • 今日秒杀(未使用)
    • 商品详情
    • 整点秒杀商品列表
    • 正在进行|即将开始 秒杀列表(未使用)
    • 加入购物车
    • 秒杀整点时间段列表
    • 秒杀订单提交(参数与商城相同)
    • 秒杀订单预览(参数与商城相同)
    • 秒杀首页
    • 购物车编辑
  • DIY装修API
    • 页面详情
  • 多商户
    • 修改订单总价
    • 资产首页
    • 单商品修改价格
    • 售后订单详情
    • 订单同意|拒绝取消
    • 订单发货
    • 获取面单
    • 结算记录
    • 商品申请上架
    • 收支记录
    • 提现记录
    • 商家售后处理
    • 提现申请
    • 快递公司列表
    • 多商户入驻申请
    • 多商户列表
    • 多商户更新密码
    • 多商户状态
    • 店铺统计年份列表
    • 多商户账号密码登录
    • 多商户详情
    • 多商户类目列表
    • 商品列表
    • 商品详情
    • 分类样式配置
    • 商品分类列表
    • 商城-多商户设置
    • 添加访客记录
    • 商品上下架
    • 商品删除
    • 商户订单详情
    • 商户订单列表
    • 店铺二维码
    • 获取二维码参数
    • 店铺统计
    • 我的店铺首页
  • 数据统计
    • 数据统计-店铺查询
    • 合伙人排行
    • 商品分类列表
    • 头部公告
    • 头部总览数据
    • 对账单
    • 幸运抽奖
    • 拼团
    • 插件菜单
    • 数据统计
    • 数据统计-商品排序导出
    • 数据统计-图表
    • 发放统计
    • 数据统计-用户排序导出
    • 整点秒杀
    • 步数兑换
    • 步数挑战
    • 砍价
    • 积分商城
    • 积分收支
    • 经营概况
    • 裂变拆红包
    • 销售统计-门店-多商户
    • 预约
  • 小程序管理界面
    • 商品编辑获取配置
    • 会员列表
    • 门店列表
    • 退货退款订单确认收货
    • 评价置顶
    • 订单添加备注
    • 订单发货
    • 后台绑定管理员
    • 后台解绑管理员
    • 解除核销员
    • 获取面单
    • 获取提现消息tab栏
    • 队长审核队列查询
    • 商品详情
    • 确认收货
    • 审核消息列表--第二版
    • 审核消息处理--第二版
    • 审核消息详情--第二版
    • 提现审核
    • 提现审核与打款(新)
    • 提现审核列表
    • 提现审核列表(新)
    • 更新用户备注名
    • 更新用户备注
    • 更新用户会员等级
    • 首页总览数据
    • 物流列表
    • 获取商品列表
    • 商品上下架
    • 删除商品
    • 评价列表
    • 回复评论
    • 隐藏评价
    • 用户列表
    • 合伙人
    • 核销员列表
    • 用户积分充值/抵扣
    • 用户余额充值/抵扣
    • 获取商城配置
    • 入驻商/合伙人审核 列表
    • 获取审核消息tab栏
    • 获取入驻商申请详情信息
    • 入驻商/合伙人 审核通过/拒绝
    • 首页图表
    • 订单列表/订单消息
    • 修改总价格
    • 修改收货信息
    • 收货地址列表
    • 查看物流
    • 取消订单
    • 订单详情后台
    • 售后列表/订单消息-售后
    • 售后处理
    • 新增商品
    • 获取商品服务列表
    • 获取商品卡券列表
    • 获取商品分类列表
  • 团队分红--插件
    • 新增/编辑等级
    • 队长等级列表
    • 前端发起提现
    • 前端获取团队分红设置
    • 可用等级列表
    • 后台删除被拒绝的队长审核
    • 后台备注提现申请
    • 后台审核打款拒绝提现
    • 后台提现列表
    • 后台解除队长
    • 后台队长列表
    • 后台队长备注
    • 后台队长审核
    • 获取等级
    • 团队分红设置
    • 分红订单/订单列表相关
    • 查看审核状态
    • 查看是否符合申请要求
    • 查询解除队长队列执行状态
    • 查询队长审核队列执行状态
    • 清除申请状态
    • 申请队长
    • 禁用或恢复
    • 移除等级
    • 获取团队分红设置
    • 获取所有等级
    • 订单详情
    • 订单备注
    • 团员列表
    • 分红统计
  • 手机核销
    • 核销订单列表
    • 我的核销订单列表
    • 订单详情
    • 订单核销
    • 核销卡卷列表
    • 我的核销卡卷列表
    • 卡券详情
    • 卡券核销
    • 核销统计
    • 是否是平台核销员
  • 扫码买单后台
    • 买单设置优惠券列表
    • 买单设置会员列表
    • 买单设置列表
    • 买单设置删除
    • 买单设置卡券列表
    • 买单设置新增|更新
    • 买单设置更新状态
    • 买单设置详情
  • 扫码买单小程序端
    • 扫码买单 取消订单
    • 扫码买单下单
    • 扫码买单二维码
    • 扫码买单优惠券
    • 扫码买单预览
    • 扫码买单首页
  • 同城配送
    • 后台设置
    • 编辑保存
    • 获取配送费
    • 配送员信息
  • 超级会员卡--插件
    • 会员卡下单
    • 我的会员卡信息
    • 新的主卡权益接口
    • 获取会员卡
    • 获取会员卡设置
    • 获取子卡详情
    • 预览会员卡
  • 预售--插件
    • 分享海报
    • 商品列表
    • 商品详情
    • 定金付款
    • 首页轮播图
  • 礼物--插件
    • 海报
    • 后台--基本设置
    • 填写地址预览
    • 我参与的列表/详情
    • 我收到的列表/详情
    • 我送出的
    • 我送出的详情
    • 插件相关设置
    • 填写地址提交
    • 礼物下单
    • 礼物记录
    • 被转赠
    • 转赠
    • 送礼取消支付
    • 领取记录
    • 领取详情
  • 下单
    • 订单信息预览
  • diy接口
    • 搜索框组件
    • 专题
    • 倒计时
    • 公共信息
    • 公告
    • 关联链接
    • 商品
    • 图文详情
    • 图片广告
    • 地图
    • 好店推荐
    • 导航图标
    • 幸运抽奖
    • 弹窗广告
    • 微信公众号
    • 快捷导航
    • 拼团
    • 优惠券
    • 流量主
    • 版权
    • 用户信息
    • 砍价
    • 秒杀
    • 积分商城
    • 空白快
    • 签到
    • 自定义表单
    • 视频
    • 订单入口
    • 超级会员卡
    • 轮播图
    • 门店
    • 预售
    • 预约
  • 订单管理
    • 订单列表
    • 售后用户发货
    • 售后订单详情
    • 未付款订单支付
    • 核销订单确认收款
    • 物流公司列表
    • 生成售后订单
    • 申请售后
    • 售后订单列表
    • 订单取消|申请取消
    • 订单核销
    • 订单核销码
    • 订单物流详情
    • 订单确认收货
    • 订单评价
    • 订单详情
  • 裂变红包
    • 分享赠送
    • 后台新增/编辑活动
    • 拆红包
    • 拆红包结果
    • 拆红包详情
    • 活动配置
  • 订单后台
    • 售后列表
    • 售后处理
    • 订单列表
    • 订单详情后台
  • 步数宝后台
    • 活动解散
    • 商品列表
    • 商品编辑预览
    • 基本设置列表
    • 基本设置提交
    • 步数币修改
    • 活动保存
    • 活动列表
    • 活动删除
    • 活动参与名单
    • 活动编辑
    • 商品编辑提交
    • 活动首页状态
    • 流量主列表
    • 流量主删除
    • 流量主编辑详情
    • 流量主编辑详情提交
    • 流量主首页切换
    • 用户中心
    • 用户兑换记录
    • 用户邀请记录
    • 轮播图列表
    • 轮播图编辑
  • 步数宝前端
    • 活动提交
    • 参加活动
    • 商品详情
    • 基本配置
    • 排行
    • 步数排行
    • 每日兑换
    • 活动列表
    • 商品列表
    • 活动记录
    • 活动详情
    • 用户提醒
    • 用户记录
    • 订单提交
    • 订单预览
    • 邀请列表
    • 首页接口
  • 卡券
    • 二维码接口
    • 卡券核销
    • 卡券详情
    • 我的卡券列表
    • 海报
    • 赠送页面
    • 领取赠送的卡券
  • 商品
    • 商品推荐列表
    • 商品视频列表
    • 评价列表
  • 后台-商城管理
    • 创建商城
    • 商城列表
    • 商城加入回收站|恢复
    • 商城禁用|解禁
    • 商城迁移
    • 回收站删除商城
    • 版权设置
  • 砍价
    • 轮播图
    • 商品列表
    • 商品详情
    • 用户发起砍价订单
    • 用户发起砍价结果
    • 用户参与砍价
    • 用户参与砍价结果
    • 活动页面
    • 砍价基础设置
    • 我的砍价
  • 积分商城
    • 订单详情
    • 商品放置首页
    • 订单列表
    • 积分商城设置
    • 删除优惠券
    • 清空回收站
    • 用户兑换券列表
    • 轮播图列表
    • 添加轮播图
    • 商品列表
    • 添加商品
    • 商品删除
    • 商品详情
    • 优惠券列表
    • 添加优惠券
  • 积分商城-插件
    • 分类商品列表
    • 优惠券兑换列表
    • 优惠券列表
    • 优惠券订单提交
    • 优惠券订单支付
    • 优惠券详情
    • 兑换商品详情
    • 优惠券兑换详情
    • 商品兑换列表
    • 商品分类列表
    • 商品详情
    • 积分商城首页
    • 积分明细列表
    • 订单提交
    • 订单预览
  • coupon
    • 优惠券列表
    • 优惠券海报
    • 优惠券详情
    • 优惠券领取
    • 分享获得优惠券
    • 我的优惠券
    • 我的优惠券详情
  • 收藏
    • 取消商品收藏
    • 我的收藏分类
    • 我的收藏列表(商品)
    • 我的收藏(专题)
    • 批量取消收藏
    • 添加商品收藏
  • 文章
    • 文章列表
    • 文章详情
  • 快速购买
    • 分类商品
    • 快速购买首页
    • 购物车
  • 收货地址
    • 地址保存
    • 地址删除
    • 地址详情
    • 地址默认
    • 微信省市区
    • 用户收货首页
  • default
    • 3级分类
    • 分类列表
    • 商品列表
    • 省市区
  • 附件
    • 附件上传
  • 余额充值
    • 余额充值设置
    • 余额日志记录
    • 充值
    • 充值金额列表
    • 首页
  • 合伙人
    • 提现明细
    • 合伙人佣金
    • 合伙人等级立即升级
    • 合伙人订单
    • 合伙人设置
    • 合伙人首页
    • 提现
    • 合伙人等级升级条件
    • 申请合伙人
    • 申请状态查询
    • 申请状态查询--合伙人等级之后版本
    • 绑定合伙人关系
    • 自定义
    • 获取团队详情
  • 视频专区
    • 视频列表
    • 视频播放接口
  • 购物车
    • 列表
    • 批量删除
    • 批量编辑
    • 购物车添加
  • user
    • 余额日志记录
    • 发送验证码
    • 手机手动绑定
    • 手机绑定
    • 用户信息
  • 会员中心
    • 会员专属商品分类列表
    • 会员专属商品列表
    • 会员优惠券列表
    • 会员列表
    • 会员详情
    • 购买会员
    • 首页
  • 专题
    • 专题分类
    • 专题列表
    • 专题详情
    • 文章收藏
  • 小票打印后台
    • 列表
    • 删除
    • 编辑数据
    • 编辑提交
    • 打印设置列表
    • 打印设置
    • 打印设置提交
    • 打印设置删除

驹家小程序端

index

diy页面--接口路径和首页布局一样,只是多带了个参数page_id

基本信息

Path: /api/index/index2

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ home_pagesobject非必须
├─ idstring非必须diy页面id
├─ titlestring非必须diy页面名称
├─ show_navsstring非必须是否展示导航条0--否1--是
├─ is_home_pagestring非必须是否设置成首页0--否1--是
├─ navsobject []非必须导航条列表

item 类型: object

├─ idstring非必须导航条id
├─ namestring非必须导航条名称
├─ page_idstring非必须
├─ template_idstring非必须
├─ templateobject非必须模板
├─ idstring非必须模板id
├─ namestring非必须模板名称
├─ dataobject []非必须模板数据

item 类型: object

├─ idstring必须组件id

枚举: search--搜索框,nav--导航图标,banner--轮播图,notice--公告,topic--专题,link--关联链接,rubik--图片广告,video--视频,goods--商品,store--门店,copyright--版权,check-in--签到,user-info--用户信息,user-order--订单入口,map--地图,mp-link--微信公众号,form--自定义表单,image-text--图文详情,coupon--优惠券,timer--倒计时,mch--好店推荐,pintuan--拼团,booking--预约,miaosha--秒杀,bargain--砍价,integral-mall--积分商城,lottery--抽奖,advance--预售,vip-card--超级会员卡,empty--空白块,ad--流量主广告,modal--弹窗广告,quick-nav--快捷导航

├─ dataobject必须组件数据---具体详情见《diy接口》
├─ colorstring非必须搜索框颜色 当组件id=search是生效
├─ backgroundstring非必须背景色 当组件id=search生效 当组件id=notice生效
├─ radiusnumber非必须边框圆角 当组件id=search时生效
├─ placeholderstring非必须提示内容 当组件id=search时生效
├─ textColorstring非必须文字颜色 当组件id=search时生效 当组件id=notice时生效
├─ textPositionstring非必须提示文字位置 当组件id=search时生效

枚举: left--靠左,center--居中,right--靠右

├─ rowsnumber非必须导航图标每页显示的行数 当组件id=nav时生效
├─ columnsnumber非必须导航图标每行显示的个数 当组件id=nav时生效
├─ scrollboolean非必须是否允许左右滑动 false--不允许|true--允许 当组件id=nav时生效
├─ navsobject []非必须导航图标列表 当组件id=nav时生效

item 类型: object

├─ urlstring必须链接路由
├─ openTypestring必须链接类型
├─ picUrlstring必须
├─ textstring必须
├─ numstring必须
├─ open_typestring必须链接类型
├─ link_urlstring必须链接路由
├─ namestring必须名称
├─ icon_urlstring必须
├─ iconstring必须 导航图标图片地址
├─ paramsobject []必须链接参数

item 类型: object

├─ keystring必须参数key
├─ valuestring必须参数值
├─ stylenumber,string非必须当组件id=banner时,轮播图样式1--全屏展示|2--卡片形式 当组件id=topic时,专题样式normal--简易模式|list--列表模式
├─ fillnumber非必须图片填充方式:0--留白|1--填充 当组件id=banner时生效
├─ heightnumber非必须组件高度 当组件id=banner时生效
├─ bannersobject []非必须轮播图列表

item 类型: object

├─ picUrlstring非必须轮播图图片地址
├─ openTypestring非必须链接类型
├─ urlstring非必须链接路由
├─ paramsobject []非必须链接参数

item 类型: object

├─ keystring非必须参数key
├─ valuestring非必须参数值
├─ page_urlstring非必须链接路由
├─ open_typestring非必须链接类型
├─ pic_urlstring非必须轮播图图片地址
├─ namestring非必须当组件id=notice时,公告名称
├─ contentstring非必须当组件id=notice时,公告内容
├─ iconstring非必须当组件id=notice时,公告图标
├─ headerUrlstring非必须当组件id=notice时,公告弹窗头部图片
├─ btnColorstring非必须当组件id=notice时,公告弹窗按钮背景色
├─ btnWidthnumber非必须当组件id=notice时,公告弹窗按钮宽度
├─ btnHeightnumber非必须当组件id=notice时,公告弹窗按钮高度
├─ btnRadiusnumber非必须当组件id=notice时,公告弹窗按钮圆角
├─ btnTextstring非必须当组件id=notice时,公告弹窗文字
├─ btnTextColorstring非必须当组件id=notice时,公告弹窗文字颜色
├─ countnumber非必须当组件id=topic、style=normal时,专题显示数量
├─ logo_1string非必须一行一个专题图标
├─ logo_2string非必须一行两个专题图标
├─ listobject []非必须当组件id=topic时,专题列表

item 类型: object

├─ wnumber必须当组件id=rubik时,图片宽度
├─ hnumber必须当组件id=rubik时,图片高度
├─ xnumber必须当组件id=rubik时,图片左边距
├─ ynumber必须当组件id=rubik时,图片上边距
├─ linkstring []必须当组件id=rubik时,图片链接

item 类型: string

├─ 非必须
├─ widthstring必须当组件id=rubik时,图片宽度
├─ heightstring必须当组件id=rubik时,图片高度
├─ leftstring必须当组件id=rubik时,图片左边距
├─ topstring必须当组件id=rubik时,图片上边距
├─ pic_urlstring必须当组件id=rubik时,图片地址
├─ idnumber,string必须当组件id=goods时,商品id
├─ goods_warehouse_idnumber必须当组件id=goods时,商品库id
├─ mch_idnumber必须当组件id=goods时,商品所属商户id
├─ signstring必须当组件id=goods时,商品所属插件标示
├─ namestring必须当组件id=goods时,商品名称
├─ cover_picstring必须
├─ original_pricestring必须
├─ unitstring必须
├─ page_urlstring必须
├─ is_negotiablenumber,string必须
├─ is_levelnumber,string必须
├─ level_pricenumber必须
├─ pricestring必须
├─ price_contentstring必须
├─ is_salesstring必须
├─ salesstring必须
├─ vip_card_appointobject必须
├─ discountnull,string非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ mobilestring必须
├─ scorenumber必须
├─ longitudestring必须
├─ latitudestring必须
├─ picUrlstring必须
├─ goodsNumstring必须
├─ orderNumstring必须
├─ goodsListobject []必须

item 类型: object

├─ idnumber必须
├─ namestring必须
├─ picUrlstring必须
├─ pricestring必须
├─ showGoodsNumnumber必须
├─ staticGoodsboolean必须
├─ goods_numstring必须
├─ people_numnumber非必须
├─ pintuan_pricestring非必须
├─ start_timestring必须
├─ end_timestring必须
├─ goods_idstring非必须
├─ mall_idstring非必须
├─ ladder_rulesstring非必须
├─ depositstring非必须
├─ swell_depositstring非必须
├─ start_prepayment_atstring非必须
├─ end_prepayment_atstring非必须
├─ pay_limitstring非必须
├─ is_deletestring非必须
├─ attrobject []非必须

item 类型: object

├─ idstring非必须
├─ goods_idstring非必须
├─ sign_idstring非必须
├─ stockstring非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightstring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ attrobject非必须
├─ idstring非必须
├─ depositstring非必须
├─ swell_depositstring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ is_deletestring非必须
├─ advance_numstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ goodsCatRelationobject []非必须

item 类型: object

├─ idstring非必须
├─ goods_warehouse_idstring非必须
├─ cat_idstring非必须
├─ is_deletestring非必须
├─ catsobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ parent_idstring非必须
├─ namestring非必须
├─ pic_urlstring非必须
├─ sortstring非必须
├─ big_pic_urlstring非必须
├─ advert_picstring非必须
├─ advert_urlstring非必须
├─ statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_showstring非必须
├─ mchstring非必须
├─ cat_showboolean非必须
├─ topic_listobject []非必须

item 类型: object

├─ idnumber必须
├─ titlestring必须
├─ cover_picstring必须
├─ read_countstring必须
├─ layoutnumber必须
├─ pic_listarray,null必须
├─ titlestring非必须
├─ textLeftnumber非必须
├─ linkobject非必须
├─ typestring非必须
├─ namestring非必须
├─ open_typestring非必须
├─ iconstring非必须
├─ valuestring非必须
├─ idnumber非必须
├─ new_link_urlstring非必须
├─ urlstring非必须
├─ openTypestring非必须
├─ dataobject非必须
├─ typestring非必须
├─ namestring非必须
├─ open_typestring非必须
├─ iconstring非必须
├─ valuestring非必须
├─ idnumber非必须
├─ new_link_urlstring非必须
├─ picSwitchboolean非必须
├─ arrowsSwitchboolean非必须
├─ picUrlstring非必须
├─ picLeftnumber非必须
├─ spacenumber非必须
├─ wnumber非必须
├─ hnumber非必须
├─ hotspotarray,null非必须
├─ pic_urlstring非必须
├─ urlstring非必须
├─ showCatboolean非必须
├─ catPositionstring非必须
├─ catStylenumber非必须
├─ catListstring []非必须

item 类型: string

├─ 非必须
├─ listStylenumber非必须
├─ goodsCoverProportionstring非必须
├─ goodsStylenumber非必须
├─ showGoodsNameboolean非必须
├─ showGoodsPriceboolean非必须
├─ showBuyBtnboolean非必须
├─ buyBtnstring非必须
├─ buyBtnStylenumber非必须
├─ buyBtnTextstring非必须
├─ showGoodsTagboolean非必须
├─ customizeGoodsTagboolean非必须
├─ goodsTagPicUrlstring非必须
├─ navPicUrlstring非必须
├─ scorePicUrlstring非必须
├─ showNameboolean非必须
├─ showScoreboolean非必须
├─ showTelboolean非必须
├─ textstring非必须
├─ backgroundColorstring非必须
├─ backgroundPicUrlstring非必须
├─ showTextboolean非必须
├─ awardobject非必须
├─ continuenumber非必须
├─ numberstring非必须
├─ typestring非必须
├─ locationstring非必须
├─ paddingYnumber非必须
├─ paddingXnumber非必须
├─ marginTopnumber非必须
├─ marginTopColorstring非必须
├─ latitudestring非必须
├─ longitudenumber非必须
├─ positionstring,number非必须
├─ inputPaddingnumber非必须
├─ marginBottomnumber非必须
├─ typenumber非必须
├─ timesnumber非必须
├─ inputBackgroundstring非必须
├─ inputBorderstring非必须
├─ inputLabelstring非必须
├─ inputTipstring非必须
├─ inputTextstring非必须
├─ buttonHeightnumber非必须
├─ buttonPaddingnumber非必须
├─ buttonMarginnumber非必须
├─ paddingnumber非必须
├─ buttonRadiusnumber非必须
├─ borderContentstring非必须
├─ borderBackgroundstring非必须
├─ borderBorderstring非必须
├─ borderTextstring非必须
├─ marginColorstring非必须
├─ showImgboolean非必须
├─ modenumber非必须
├─ backgroundHeightnumber非必须
├─ backgroundWidthnumber非必须
├─ formDialogobject []非必须

item 类型: object

├─ keystring必须
├─ key_namestring必须
├─ namestring必须
├─ is_requirednumber必须
├─ receiveBgstring非必须
├─ unclaimedBgstring非必须
├─ coupon_listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ namestring必须
├─ typestring必须
├─ discountstring必须
├─ discount_limitnull必须
├─ pic_urlstring必须
├─ descstring必须
├─ min_pricestring必须
├─ sub_pricestring必须
├─ total_countstring必须
├─ sortstring必须
├─ expire_typestring必须
├─ expire_daystring必须
├─ begin_timestring必须
├─ end_timestring必须
├─ appoint_typestring必须
├─ rulestring必须
├─ is_memberstring必须
├─ is_deletestring必须
├─ deleted_atstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ is_receivestring必须
├─ couponCatstring []必须

item 类型: string

├─ 非必须
├─ catstring []必须

item 类型: string

├─ 非必须
├─ couponGoodsobject []必须

item 类型: object

├─ idstring必须
├─ coupon_idstring必须
├─ goods_warehouse_idstring必须
├─ is_deletestring必须
├─ goodsobject []必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ namestring必须
├─ original_pricestring必须
├─ cost_pricestring必须
├─ detailstring必须
├─ cover_picstring必须
├─ pic_urlstring必须
├─ video_urlstring必须
├─ unitstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ page_urlstring必须
├─ startDateTimestring非必须
├─ endDateTimestring非必须
├─ showGoodsboolean非必须
├─ buttonColorstring非必须
├─ showCouponboolean非必须
├─ couponColorstring非必须
├─ couponPicUrlstring非必须
├─ goodsIndexnumber非必须
├─ start_xnumber非必须
├─ buy_bgstring非必须
├─ renew_bgstring非必须
├─ buy_big_colorstring非必须
├─ buy_small_colorstring非必须
├─ buy_btn_colorstring非必须
├─ buy_btn_bg_colorstring非必须
├─ buy_bigstring非必须
├─ buy_smallstring非必须
├─ buy_btn_textstring非必须
├─ renew_text_colorstring非必须
├─ renew_btn_bg_colorstring非必须
├─ renew_textstring非必须
├─ usePluginConfigboolean非必须
├─ top_bottom_paddingnumber非必须
├─ idstring非必须
├─ openedboolean非必须
├─ closedPicUrlstring非必须
├─ openedPicUrlstring非必须
├─ navStylestring非必须
├─ navSwitchnumber非必须
├─ useMallConfigboolean非必须
├─ customerServiceobject非必须
├─ picUrlstring非必须
├─ openednumber非必须
├─ homeobject非必须
├─ openednumber非必须
├─ picUrlstring非必须
├─ mAppobject非必须
├─ openednumber非必须
├─ small_app_idstring非必须
├─ small_app_urlstring非必须
├─ small_app_picstring非必须
├─ mapNavobject非必须
├─ openednumber非必须
├─ picUrlstring非必须
├─ addressstring非必须
├─ latitudestring非必须
├─ longitudestring非必须
├─ telobject非必须
├─ openednumber非必须
├─ picUrlstring非必须
├─ numberstring非必须
├─ webobject非必须
├─ openednumber非必须
├─ picUrlstring非必须
├─ urlstring非必须
├─ typestring非必须页面数据类型

枚举: mall--首页布局,diy--diy页面数据

商城配置

基本信息

Path: /index/config

Method: GET

接口描述:

商城配置

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ mallobject非必须
├─ namestring非必须
├─ title_barobject非必须
├─ backgroundstring非必须
├─ colorstring非必须
├─ navbarobject非必须
├─ bottom_background_colorstring非必须
├─ top_background_colorstring非必须
├─ top_text_colorstring非必须
├─ shadowboolean非必须
├─ navsobject []非必须

item 类型: object

├─ active_colorstring必须
├─ active_iconstring必须
├─ colorstring必须
├─ textstring必须
├─ iconstring必须
├─ urlstring必须
├─ open_typestring必须
├─ user_centerobject非必须
├─ is_account_statusstring非必须
├─ is_menu_statusstring非必须
├─ is_order_bar_statusstring非必须
├─ menu_stylestring非必须
├─ top_stylestring非必须
├─ top_pic_urlstring非必须
├─ accountobject []非必须

item 类型: object

├─ icon_urlstring必须
├─ namestring必须
├─ menusobject []非必须

item 类型: object

├─ icon_urlstring必须
├─ link_urlstring必须
├─ namestring必须
├─ open_typestring必须
├─ order_barobject []非必须

item 类型: object

├─ icon_urlstring必须
├─ namestring必须
├─ link_urlstring必须
├─ open_typestring必须
├─ pluginobject非必须
├─ demoobject非必须
├─ app_imageobject非必须
├─ banner_imagestring非必须
├─ aliappstring []非必须

item 类型: string

├─ 非必须
├─ wxappstring []非必须

item 类型: string

├─ 非必须
├─ pondobject非必须
├─ app_imageobject非必须
├─ pond_headstring非必须
├─ pond_successstring非必须
├─ pond_emptystring非必须
├─ scratchobject非必须
├─ app_imageobject非必须
├─ scratch_bgstring非必须
├─ scratch_winstring非必须
├─ copyrightobject非必须
├─ pic_urlstring非必须
├─ descriptionstring非必须
├─ typestring非必须
├─ link_urlstring非必须
├─ mobliestring非必须
├─ mobilestring非必须
├─ __wxapp_imgobject非必须
├─ mallobject非必须
├─ closestring非必须
├─ orderobject非必须
├─ status_barstring非必须
├─ balancestring非必须
├─ huodaostring非必须
├─ onlinestring非必须
├─ shareobject非必须
├─ applystring非必须
├─ statusstring非必须
├─ share_settingobject非必须
├─ levelnumber非必须合伙人等级 0--关闭 1--一级 2--二级 3--三级
├─ is_rebatenumber非必须合伙人内购是否开启 0--关闭 1--开启
├─ price_typenumber非必须合伙人佣金类型 1--百分比 2--固定金额
├─ firstnumber非必须一级佣金
├─ secondnumber非必须二级佣金
├─ thirdnumber非必须三级佣金
├─ share_conditionnumber非必须成为合伙人条件1--申请 2--无需申请 3--无需审核
├─ conditionnumber非必须成为下线条件 1--首次点击链接 2--首次下单 3--首次付款
├─ auto_share_valnumber非必须消费满自动成为合伙人
├─ share_goods_statusnumber非必须购买商品成为合伙人0--关闭 1--任意商品 2--指定商品
├─ share_goods_idnumber非必须购买的商品ID
├─ pay_typestring []非必须提现方式

item 类型: string

├─ 非必须
├─ cash_max_daynumber非必须每日提现上限
├─ min_moneynumber非必须最少提现金额
├─ cash_service_chargenumber非必须提现手续费
├─ agreestring非必须申请协议
├─ contentstring非必须用户须知
├─ pic_url_applystring非必须申请页面图片
├─ pic_url_statusstring非必须审核页面图片
├─ surplusCashnumber非必须今日剩余可提现金额
├─ share_setting_customobject非必须合伙人自定义设置(同合伙人--自定义设置)

测试

基本信息

Path: /cart/add

Method: GET

接口描述:
undefined

请求参数

购买框

基本信息

Path: /api/index/purchase

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ contentstring必须购买信息
├─ time_strstring必须时间信息
├─ avatarstring必须头像
├─ page_urlstring必须跳转路径
├─ signstring必须插件标识
├─ goods_idnumber必须商品id

首页布局

基本信息

Path: /api/index/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page_id 是 0
longitude 是
latitude 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ home_pagesobject非必须
├─ idstring非必须diy页面id
├─ titlestring非必须diy页面名称
├─ show_navsstring非必须是否展示导航条0--否1--是
├─ is_home_pagestring非必须是否设置成首页0--否1--是
├─ navsobject []非必须导航条列表

item 类型: object

├─ idstring非必须导航条id
├─ namestring非必须导航条名称
├─ page_idstring非必须
├─ template_idstring非必须
├─ templateobject非必须模板
├─ idstring非必须模板id
├─ namestring非必须模板名称
├─ dataobject []非必须模板数据

item 类型: object

├─ idstring必须组件id

枚举: search--搜索框,nav--导航图标,banner--轮播图,notice--公告,topic--专题,link--关联链接,rubik--图片广告,video--视频,goods--商品,store--门店,copyright--版权,check-in--签到,user-info--用户信息,user-order--订单入口,map--地图,mp-link--微信公众号,form--自定义表单,image-text--图文详情,coupon--优惠券,timer--倒计时,mch--好店推荐,pintuan--拼团,booking--预约,miaosha--秒杀,bargain--砍价,integral-mall--积分商城,lottery--抽奖,advance--预售,vip-card--超级会员卡,empty--空白块,ad--流量主广告,modal--弹窗广告,quick-nav--快捷导航

├─ dataobject必须组件数据
├─ colorstring非必须搜索框颜色 当组件id=search是生效
├─ backgroundstring非必须背景色 当组件id=search生效 当组件id=notice生效
├─ radiusnumber非必须边框圆角 当组件id=search时生效
├─ placeholderstring非必须提示内容 当组件id=search时生效
├─ textColorstring非必须文字颜色 当组件id=search时生效 当组件id=notice时生效
├─ textPositionstring非必须提示文字位置 当组件id=search时生效

枚举: left--靠左,center--居中,right--靠右

├─ rowsnumber非必须导航图标每页显示的行数 当组件id=nav时生效
├─ columnsnumber非必须导航图标每行显示的个数 当组件id=nav时生效
├─ scrollboolean非必须是否允许左右滑动 false--不允许|true--允许 当组件id=nav时生效
├─ navsobject []非必须导航图标列表 当组件id=nav时生效

item 类型: object

├─ urlstring必须链接路由
├─ openTypestring必须链接类型
├─ picUrlstring必须
├─ textstring必须
├─ numstring必须
├─ open_typestring必须链接类型
├─ link_urlstring必须链接路由
├─ namestring必须名称
├─ icon_urlstring必须
├─ iconstring必须 导航图标图片地址
├─ paramsobject []必须链接参数

item 类型: object

├─ keystring必须参数key
├─ valuestring必须参数值
├─ stylenumber,string非必须当组件id=banner时,轮播图样式1--全屏展示|2--卡片形式 当组件id=topic时,专题样式normal--简易模式|list--列表模式
├─ fillnumber非必须图片填充方式:0--留白|1--填充 当组件id=banner时生效
├─ heightnumber非必须组件高度 当组件id=banner时生效
├─ bannersobject []非必须轮播图列表

item 类型: object

├─ picUrlstring非必须轮播图图片地址
├─ openTypestring非必须链接类型
├─ urlstring非必须链接路由
├─ paramsobject []非必须链接参数

item 类型: object

├─ keystring非必须参数key
├─ valuestring非必须参数值
├─ page_urlstring非必须链接路由
├─ open_typestring非必须链接类型
├─ pic_urlstring非必须轮播图图片地址
├─ namestring非必须当组件id=notice时,公告名称
├─ contentstring非必须当组件id=notice时,公告内容
├─ iconstring非必须当组件id=notice时,公告图标
├─ headerUrlstring非必须当组件id=notice时,公告弹窗头部图片
├─ btnColorstring非必须当组件id=notice时,公告弹窗按钮背景色
├─ btnWidthnumber非必须当组件id=notice时,公告弹窗按钮宽度
├─ btnHeightnumber非必须当组件id=notice时,公告弹窗按钮高度
├─ btnRadiusnumber非必须当组件id=notice时,公告弹窗按钮圆角
├─ btnTextstring非必须当组件id=notice时,公告弹窗文字
├─ btnTextColorstring非必须当组件id=notice时,公告弹窗文字颜色
├─ countnumber非必须
├─ logo_1string非必须
├─ logo_2string非必须
├─ listobject []非必须

item 类型: object

├─ wnumber必须
├─ hnumber必须
├─ xnumber必须
├─ ynumber必须
├─ linkstring []必须

item 类型: string

├─ 非必须
├─ widthstring必须
├─ heightstring必须
├─ leftstring必须
├─ topstring必须
├─ pic_urlstring必须
├─ backgroundImagestring必须
├─ backgroundRepeatstring必须
├─ backgroundSizestring必须
├─ backgroundPositionstring必须
├─ zIndexnumber必须
├─ idnumber,string必须
├─ goods_warehouse_idnumber必须
├─ mch_idnumber必须
├─ signstring必须
├─ namestring必须
├─ cover_picstring必须
├─ original_pricestring必须
├─ unitstring必须
├─ page_urlstring必须
├─ is_negotiablenumber,string必须
├─ is_levelnumber,string必须
├─ level_pricenumber必须
├─ pricestring必须
├─ price_contentstring必须
├─ is_salesstring必须
├─ salesstring必须
├─ vip_card_appointobject必须
├─ discountnull,string非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ mobilestring必须
├─ scorenumber必须
├─ longitudestring必须
├─ latitudestring必须
├─ picUrlstring必须
├─ goodsNumstring必须
├─ orderNumstring必须
├─ goodsListobject []必须

item 类型: object

├─ idnumber必须
├─ namestring必须
├─ picUrlstring必须
├─ pricestring必须
├─ showGoodsNumnumber必须
├─ staticGoodsboolean必须
├─ goods_numstring必须
├─ people_numnumber非必须
├─ pintuan_pricestring非必须
├─ start_timestring必须
├─ end_timestring必须
├─ goods_idstring非必须
├─ mall_idstring非必须
├─ ladder_rulesstring非必须
├─ depositstring非必须
├─ swell_depositstring非必须
├─ start_prepayment_atstring非必须
├─ end_prepayment_atstring非必须
├─ pay_limitstring非必须
├─ is_deletestring非必须
├─ attrobject []非必须

item 类型: object

├─ idstring非必须
├─ goods_idstring非必须
├─ sign_idstring非必须
├─ stockstring非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightstring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ attrobject非必须
├─ idstring非必须
├─ depositstring非必须
├─ swell_depositstring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ is_deletestring非必须
├─ advance_numstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ goodsCatRelationobject []非必须

item 类型: object

├─ idstring非必须
├─ goods_warehouse_idstring非必须
├─ cat_idstring非必须
├─ is_deletestring非必须
├─ catsobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ parent_idstring非必须
├─ namestring非必须
├─ pic_urlstring非必须
├─ sortstring非必须
├─ big_pic_urlstring非必须
├─ advert_picstring非必须
├─ advert_urlstring非必须
├─ statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_showstring非必须
├─ mchstring非必须
├─ cat_showboolean非必须
├─ topic_listobject []非必须

item 类型: object

├─ idnumber必须
├─ titlestring必须
├─ cover_picstring必须
├─ read_countstring必须
├─ layoutnumber必须
├─ pic_listarray,null必须
├─ titlestring非必须
├─ textLeftnumber非必须
├─ linkobject非必须
├─ typestring非必须
├─ namestring非必须
├─ open_typestring非必须
├─ iconstring非必须
├─ valuestring非必须
├─ idnumber非必须
├─ new_link_urlstring非必须
├─ urlstring非必须
├─ openTypestring非必须
├─ dataobject非必须
├─ typestring非必须
├─ namestring非必须
├─ open_typestring非必须
├─ iconstring非必须
├─ valuestring非必须
├─ idnumber非必须
├─ new_link_urlstring非必须
├─ picSwitchboolean非必须
├─ arrowsSwitchboolean非必须
├─ picUrlstring非必须
├─ picLeftnumber非必须
├─ spacenumber非必须
├─ wnumber非必须
├─ hnumber非必须
├─ hotspotarray,null非必须
├─ pic_urlstring非必须
├─ urlstring非必须
├─ showCatboolean非必须
├─ catPositionstring非必须
├─ catStylenumber非必须
├─ catListstring []非必须

item 类型: string

├─ 非必须
├─ listStylenumber非必须
├─ goodsCoverProportionstring非必须
├─ goodsStylenumber非必须
├─ showGoodsNameboolean非必须
├─ showGoodsPriceboolean非必须
├─ showBuyBtnboolean非必须
├─ buyBtnstring非必须
├─ buyBtnStylenumber非必须
├─ buyBtnTextstring非必须
├─ showGoodsTagboolean非必须
├─ customizeGoodsTagboolean非必须
├─ goodsTagPicUrlstring非必须
├─ navPicUrlstring非必须
├─ scorePicUrlstring非必须
├─ showNameboolean非必须
├─ showScoreboolean非必须
├─ showTelboolean非必须
├─ textstring非必须
├─ backgroundColorstring非必须
├─ backgroundPicUrlstring非必须
├─ showTextboolean非必须
├─ awardobject非必须
├─ continuenumber非必须
├─ numberstring非必须
├─ typestring非必须
├─ locationstring非必须
├─ paddingYnumber非必须
├─ paddingXnumber非必须
├─ marginTopnumber非必须
├─ marginTopColorstring非必须
├─ latitudestring非必须
├─ longitudenumber非必须
├─ positionstring,number非必须
├─ inputPaddingnumber非必须
├─ marginBottomnumber非必须
├─ typenumber非必须
├─ timesnumber非必须
├─ inputBackgroundstring非必须
├─ inputBorderstring非必须
├─ inputLabelstring非必须
├─ inputTipstring非必须
├─ inputTextstring非必须
├─ buttonHeightnumber非必须
├─ buttonPaddingnumber非必须
├─ buttonMarginnumber非必须
├─ paddingnumber非必须
├─ buttonRadiusnumber非必须
├─ borderContentstring非必须
├─ borderBackgroundstring非必须
├─ borderBorderstring非必须
├─ borderTextstring非必须
├─ marginColorstring非必须
├─ showImgboolean非必须
├─ modenumber非必须
├─ backgroundHeightnumber非必须
├─ backgroundWidthnumber非必须
├─ formDialogobject []非必须

item 类型: object

├─ keystring必须
├─ key_namestring必须
├─ namestring必须
├─ is_requirednumber必须
├─ receiveBgstring非必须
├─ unclaimedBgstring非必须
├─ coupon_listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ namestring必须
├─ typestring必须
├─ discountstring必须
├─ discount_limitnull必须
├─ pic_urlstring必须
├─ descstring必须
├─ min_pricestring必须
├─ sub_pricestring必须
├─ total_countstring必须
├─ sortstring必须
├─ expire_typestring必须
├─ expire_daystring必须
├─ begin_timestring必须
├─ end_timestring必须
├─ appoint_typestring必须
├─ rulestring必须
├─ is_memberstring必须
├─ is_deletestring必须
├─ deleted_atstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ is_receivestring必须
├─ couponCatstring []必须

item 类型: string

├─ 非必须
├─ catstring []必须

item 类型: string

├─ 非必须
├─ couponGoodsobject []必须

item 类型: object

├─ idstring必须
├─ coupon_idstring必须
├─ goods_warehouse_idstring必须
├─ is_deletestring必须
├─ goodsobject []必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ namestring必须
├─ original_pricestring必须
├─ cost_pricestring必须
├─ detailstring必须
├─ cover_picstring必须
├─ pic_urlstring必须
├─ video_urlstring必须
├─ unitstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ page_urlstring必须
├─ startDateTimestring非必须
├─ endDateTimestring非必须
├─ showGoodsboolean非必须
├─ buttonColorstring非必须
├─ showCouponboolean非必须
├─ couponColorstring非必须
├─ couponPicUrlstring非必须
├─ goodsIndexnumber非必须
├─ start_xnumber非必须
├─ buy_bgstring非必须
├─ renew_bgstring非必须
├─ buy_big_colorstring非必须
├─ buy_small_colorstring非必须
├─ buy_btn_colorstring非必须
├─ buy_btn_bg_colorstring非必须
├─ buy_bigstring非必须
├─ buy_smallstring非必须
├─ buy_btn_textstring非必须
├─ renew_text_colorstring非必须
├─ renew_btn_bg_colorstring非必须
├─ renew_textstring非必须
├─ usePluginConfigboolean非必须
├─ top_bottom_paddingnumber非必须
├─ idstring非必须
├─ openedboolean非必须
├─ closedPicUrlstring非必须
├─ openedPicUrlstring非必须
├─ navStylestring非必须
├─ navSwitchnumber非必须
├─ useMallConfigboolean非必须
├─ customerServiceobject非必须
├─ picUrlstring非必须
├─ openednumber非必须
├─ homeobject非必须
├─ openednumber非必须
├─ picUrlstring非必须
├─ mAppobject非必须
├─ openednumber非必须
├─ small_app_idstring非必须
├─ small_app_urlstring非必须
├─ small_app_picstring非必须
├─ mapNavobject非必须
├─ openednumber非必须
├─ picUrlstring非必须
├─ addressstring非必须
├─ latitudestring非必须
├─ longitudestring非必须
├─ telobject非必须
├─ openednumber非必须
├─ picUrlstring非必须
├─ numberstring非必须
├─ webobject非必须
├─ openednumber非必须
├─ picUrlstring非必须
├─ urlstring非必须
├─ typestring非必须页面数据类型

枚举: mall--首页布局,diy--diy页面数据

首页布局_copy

基本信息

Path: /api/index/index_1573526334729

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page_id 是 0

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ home_pagesobject []非必须

item 类型: object

├─ keystring必须组件key

枚举: search--搜索,banner--轮播图,home_nav--导航图标,video--视频,notice--公告,topic--专题,cat--分类,pintuan--拼团,mch--好店推荐,booking--预约,advance--预售,coupon--领券中心,block--图片魔方,miaosha--秒杀,fxhb--裂变红包

├─ namestring必须组件名称
├─ relation_idstring必须
├─ bannersobject []非必须轮播图 当key=banner时此参数生效

item 类型: object

├─ idstring非必须轮播图id
├─ titlestring非必须轮播图标题
├─ paramsobject []非必须轮播图链接参数

item 类型: object

├─ keystring必须参数key
├─ valuestring必须参数值
├─ open_typestring非必须轮播图链接类型
├─ pic_urlstring非必须轮播图图片
├─ page_urlstring非必须轮播图路由
├─ row_numstring非必须导航图标一行显示数量 当key=home_nav时此参数生效
├─ home_navsobject []非必须 当key=home_nav时此参数生效

item 类型: object

├─ idstring必须导航图标id
├─ icon_urlstring必须导航图标图标地址
├─ link_urlstring必须导航图标链接路由
├─ namestring必须导航图标名称
├─ open_typestring必须导航图标链接类型
├─ paramsobject []必须导航图标链接参数

item 类型: object

├─ keystring必须参数key
├─ valuestring必须参数值
├─ video_urlstring非必须视频地址 当key=video时此参数生效
├─ video_pic_urlstring非必须视频封面图 当key=video时此参数生效
├─ notice_urlstring非必须公告图片地址 当key=notice时此参数生效
├─ notice_bg_colorstring非必须公告背景色 当key=notice时此参数生效
├─ notice_text_colorstring非必须公告文字颜色 当key=notice时此参数生效
├─ notice_namestring非必须公告名称 当key=notice时此参数生效
├─ notice_contentstring非必须公告内容 当key=notice时此参数生效
├─ topic_numstring非必须专题显示数量 当key=topic时此参数生效
├─ topic_urlstring非必须一行一个专题图标 当key=topic时此参数生效
├─ topic_url_2string非必须一行两个专题图标 当key=topic时此参数生效
├─ label_urlstring非必须专题图标 当key=topic时此参数生效
├─ topicsobject []非必须专题列表 当key=topic时此参数生效

item 类型: object

├─ idstring必须专题id
├─ titlestring必须专题标题
├─ cat_pic_urlstring非必须分类图片 当key=cat时此参数生效
├─ list_stylestring非必须分类商品显示样式 当key=cat时此参数生效

枚举: 1--一行一个,2--一行两个,3--一行三个

├─ goodsobject []非必须商品列表 当key=cat时此参数生效

item 类型: object

├─ idnumber必须商品id
├─ goods_warehouse_idnumber必须商品库id
├─ mch_idnumber必须商品所属商户id
├─ signstring必须商品标示
├─ namestring必须商品名称
├─ cover_picstring必须商品封面图
├─ original_pricestring必须商品原价
├─ unitstring必须商品单位
├─ page_urlstring必须商品路由
├─ is_negotiablenumber必须是否价格面议0--否1--是
├─ is_levelnumber必须是否享受会员0--否1--是
├─ level_pricenumber必须会员价
├─ pricestring必须商品售价
├─ price_contentstring必须商品价格显示文本
├─ is_salesstring必须是否显示销量0--否1--是
├─ salesstring必须商品销量
├─ vip_card_appointobject必须
├─ discountnull非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ pintuanobject []非必须拼团商品列表 当key=pintuan时此参数生效

item 类型: object

├─ idnumber必须商品id
├─ goods_warehouse_idnumber必须商品库id
├─ mch_idnumber必须商品所属商户id
├─ signstring必须商品标示
├─ namestring必须商品名称
├─ cover_picstring必须商品封面图
├─ original_pricestring必须商品原价
├─ unitstring必须商品单位
├─ page_urlstring必须商品路由
├─ is_negotiablenumber必须是否价格面议0--否1--是
├─ is_levelnumber必须是否享受会员0--否1--是
├─ level_pricenumber必须会员价
├─ pricestring必须商品售价
├─ price_contentstring必须商品价格显示文本
├─ is_salesstring必须是否显示销量0--否1--是
├─ salesstring必须商品销量
├─ vip_card_appointobject必须同商品
├─ discountstring非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ group_countstring必须已拼团数量
├─ mchobject []非必须好店推荐 当key=mch时此参数生效

item 类型: object

├─ namestring必须商户名称
├─ cover_urlstring必须商户封面图
├─ mch_idstring必须
├─ idstring必须
├─ picUrlstring必须商户封面图
├─ bookingobject []非必须预约 当key=booking时此参数生效

item 类型: object

├─ idnumber必须商品id
├─ goods_warehouse_idnumber必须商品库id
├─ mch_idnumber必须商品所属商户id
├─ signstring必须商品标示
├─ namestring必须商品名称
├─ cover_picstring必须商品封面图
├─ original_pricestring必须商品原价
├─ unitstring必须商品单位
├─ page_urlstring必须商品路由
├─ is_negotiablenumber必须是否价格面议0--否1--是
├─ is_levelnumber必须是否享受会员0--否1--是
├─ level_pricenumber必须会员价
├─ pricestring必须商品售价
├─ price_contentstring必须商品价格显示文本
├─ is_salesstring必须是否显示销量0--否1--是
├─ salesstring必须商品销量
├─ vip_card_appointobject必须
├─ discountstring,null非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ advanceobject非必须
├─ codenumber非必须
├─ msgstring非必须
├─ dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ goods_warehouse_idstring必须
├─ statusstring必须
├─ pricestring必须
├─ use_attrstring必须
├─ attr_groupsstring必须
├─ goods_stocknumber必须
├─ virtual_salesstring必须
├─ confine_countstring必须
├─ piecesstring必须
├─ foreheadstring必须
├─ freight_idstring必须
├─ give_integralstring必须
├─ give_integral_typestring必须
├─ forehead_integralstring必须
├─ forehead_integral_typestring必须
├─ accumulativestring必须
├─ individual_sharestring必须
├─ attr_setting_typestring必须
├─ is_levelstring必须
├─ is_level_alonestring必须
├─ share_typestring必须
├─ signstring必须
├─ app_share_picstring必须
├─ app_share_titlestring必须
├─ is_default_servicesstring必须
├─ sortstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ payment_peoplestring必须
├─ payment_numstring必须
├─ payment_amountstring必须
├─ payment_orderstring必须
├─ confine_order_countstring必须
├─ is_area_limitstring必须
├─ area_limitnull必须
├─ share_level_typestring必须
├─ form_idstring必须
├─ start_prepayment_atstring必须
├─ end_prepayment_atstring必须
├─ goodsWarehouseobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ goodsCatRelationobject []非必须

item 类型: object

├─ idstring必须
├─ goods_warehouse_idstring必须
├─ cat_idstring必须
├─ is_deletestring必须
├─ catsobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ parent_idstring必须
├─ namestring必须
├─ pic_urlstring必须
├─ sortstring必须
├─ big_pic_urlstring必须
├─ advert_picstring必须
├─ advert_urlstring必须
├─ statusstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_showstring必须
├─ attrobject []必须

item 类型: object

├─ idstring必须
├─ goods_idstring必须
├─ sign_idstring必须
├─ stockstring必须
├─ pricestring必须
├─ nostring必须
├─ weightstring必须
├─ pic_urlstring必须
├─ is_deletestring必须
├─ depositnumber必须
├─ swell_depositnumber必须
├─ advanceGoodsobject必须
├─ idstring非必须
├─ goods_idstring非必须
├─ mall_idstring非必须
├─ ladder_rulesstring非必须
├─ depositnumber非必须
├─ swell_depositnumber非必须
├─ start_prepayment_atstring非必须
├─ end_prepayment_atstring非必须
├─ pay_limitstring非必须
├─ is_deletestring非必须
├─ cover_picstring必须
├─ namestring必须
├─ price_contentstring必须
├─ original_pricestring必须
├─ page_urlstring必须
├─ salesstring必须
├─ level_pricenumber必须
├─ vip_card_appointobject必须
├─ discountstring非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ coupon_urlstring非必须已领取优惠券背景图 当key=coupon时此参数生效
├─ coupon_not_urlstring非必须未领取优惠券背景图 当key=coupon时此参数生效
├─ couponsobject []非必须优惠券列表 当key=coupon时此参数生效

item 类型: object

├─ idstring必须优惠券id
├─ mall_idstring必须
├─ namestring必须优惠券名称
├─ typestring必须优惠券类型:1=折扣,2=满减
├─ discountstring必须折扣率
├─ discount_limitnull必须折扣优惠上限
├─ min_pricestring必须最低消费金额
├─ sub_pricestring必须满减券优惠金额
├─ total_countstring必须可发放的数量(剩余数量)
├─ sortstring必须排序按升序排列
├─ expire_typestring必须到期类型:1=领取后N天过期,2=指定有效期
├─ expire_daystring必须有效天数,expire_type=1时
├─ begin_timestring必须有效期开始时间
├─ end_timestring必须有效期结束时间
├─ appoint_typestring必须1 指定分类 2 指定商品 3全部 4.当面付
├─ is_receivestring必须已领取数量
├─ blockobject非必须图片魔方 当key=block时此参数生效
├─ idstring非必须图片魔方id
├─ namestring非必须图片魔方名称
├─ valueobject []非必须图片魔方图片列表

item 类型: object

├─ widthstring非必须图片宽度
├─ heightstring非必须图片高度
├─ leftnumber非必须图片左边距
├─ topnumber非必须图片上边距
├─ pic_urlstring非必须图片地址
├─ link_urlstring非必须图片链接路由
├─ linkobject非必须图片链接
├─ typestring非必须链接类型
├─ namestring非必须链接名称
├─ open_typestring非必须链接类型
├─ valuestring非必须
├─ paramsobject []非必须链接参数

item 类型: object

├─ keystring必须参数key
├─ valuestring必须参数值
├─ new_link_urlstring非必须拼接的路由
├─ typestring非必须图片类型

枚举: 1--一张图,2--两张图左右不平分,3--三张图,4--四张图,5--两张图左右平分,6--三张图左右平分,7--四张图左右平分,8--四张图上下左右平分

├─ stylenumber非必须图片魔方高度
├─ miaoshaobject非必须秒杀 当key=miaosha时此参数生效
├─ open_datestring非必须开始日期
├─ open_timestring非必须开始时间
├─ date_timenumber非必须结束时间
├─ is_currentnumber非必须
├─ listobject []非必须秒杀商品列表

item 类型: object

├─ idnumber必须商品id
├─ goods_warehouse_idnumber必须商品库id
├─ mch_idnumber必须商品所属商户id
├─ signstring必须商品标示
├─ namestring必须商品名称
├─ cover_picstring必须商品封面图
├─ original_pricestring必须商品原价
├─ unitstring必须商品单位
├─ page_urlstring必须商品路由
├─ is_negotiablenumber必须是否价格面议0--否1--是
├─ is_levelnumber必须是否享受会员0--否1--是
├─ level_pricenumber必须会员价
├─ pricestring必须商品售价
├─ price_contentstring必须商品价格显示文本
├─ is_salesstring必须是否显示销量0--否1--是
├─ salesstring必须商品销量
├─ vip_card_appointobject必须
├─ discountnull非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ fxhbobject []非必须裂变红包 当key=fxhb时此参数生效

item 类型: object

├─ picUrlstring非必须红包图片
├─ linkobject非必须红包链接
├─ openTypestring非必须链接类型
├─ urlstring非必须链接路由
├─ typestring非必须mall首页类型

枚举: mall--首页布局数据,diy--diy首页数据

门店

门店列表

基本信息

Path: /api/store/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
keyword 是 1 名称关键词
longitude 是 127 经纬度
altitude 是 30 经纬度
goods_id 是 1 商品id
page 是 1 页码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须多商户id
├─ namestring必须门店名称
├─ mobilestring必须门店号码
├─ addressstring必须地址
├─ province_idstring必须省id
├─ city_idstring必须市id
├─ district_idstring必须区id
├─ longitudestring必须经度
├─ latitudestring必须纬度
├─ scorestring必须门店评分 0-5
├─ cover_urlstring必须封面图
├─ pic_urlstring必须轮播图
├─ business_hoursstring必须营业时间
├─ descriptionstring必须描述
├─ scopestring必须范围
├─ is_defaultstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ distancestring必须距当前距离

门店详情

基本信息

Path: /api/store/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 门店id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须详见门店列表
├─ idnumber非必须
├─ mall_idnumber非必须
├─ mch_idnumber非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ province_idnumber非必须
├─ city_idnumber非必须
├─ district_idnumber非必须
├─ longitudestring非必须
├─ latitudestring非必须
├─ scorenumber非必须
├─ cover_urlstring非必须
├─ pic_urlobject []非必须

item 类型: object

├─ idstring非必须
├─ pic_urlstring非必须
├─ business_hoursstring非必须
├─ descriptionstring非必须
├─ scopestring非必须
├─ is_defaultnumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须

足迹

商品足迹

基本信息

Path: /api/footprint/footprint

Method: GET

接口描述:

默认返回今日足迹

请求参数

Query

参数名称 是否必须 示例 备注
start_time 否 开奖时间
end_time 否 结束时间

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
listobject []非必须

item 类型: object

├─ datestring必须日期组
├─ goodsobject []必须商品信息

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ goods_warehouse_idstring必须
├─ statusstring必须
├─ pricestring必须
├─ use_attrstring必须
├─ attr_groupsstring必须
├─ goods_stockstring必须
├─ virtual_salesstring必须
├─ confine_countstring必须
├─ piecesstring必须
├─ foreheadstring必须
├─ freight_idstring必须
├─ give_integralstring必须
├─ give_integral_typestring必须
├─ forehead_integralstring必须
├─ forehead_integral_typestring必须
├─ accumulativestring必须
├─ individual_sharestring必须
├─ attr_setting_typestring必须
├─ is_levelstring必须
├─ is_level_alonestring必须
├─ share_typestring必须
├─ signstring必须
├─ app_share_picstring必须
├─ app_share_titlestring必须
├─ is_default_servicesstring必须
├─ sortstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ payment_peoplestring必须
├─ payment_numstring必须
├─ payment_amountstring必须
├─ payment_orderstring必须
├─ confine_order_countstring必须
├─ is_area_limitstring必须
├─ area_limitstring,null必须
├─ share_level_typestring必须
├─ form_idstring必须
├─ date_timestring必须
├─ goodsWarehouseobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ mallGoodsobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ goods_idstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_negotiablestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须

我的数据

基本信息

Path: /api/footprint/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 否 暂时不用

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pay_pricestring非必须总消费金额
├─ pay_numstring非必须总购买商品数
├─ member_discount_pricestring非必须总会员优惠金额
├─ coupon_discount_pricestring非必须总优惠卷优惠金额
├─ coupon_numstring非必须总使用优惠卷数
├─ daystring非必须我的天数
├─ highest_pricestring非必须最高消费金额
├─ percentagestring非必须消费排行百分比
├─ typestring非必须当前查询返回数据的形式,当前为all

足迹删除

基本信息

Path: /api/footprint/footprint-del

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是

返回数据

名称类型是否必须默认值备注其他信息

股东分红--插件

分红明细

基本信息

Path: /plugin/clerk/api/cash/bonus-detail

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ level_listobject []非必须

item 类型: object

├─ level_namestring非必须
├─ listobject []非必须

item 类型: object

├─ user_idstring必须
├─ level_namestring必须等级名
├─ bonus_ratestring必须分红比例
├─ pricestring必须金额
├─ nicknamestring必须昵称
├─ avatarstring必须头像
├─ platformstring必须平台
├─ namestring必须姓名
├─ phonestring必须手机
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

升级

基本信息

Path: /plugin/stock/api/index/level-up

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

升级页面

基本信息

Path: /plugin/stock/api/index/level

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ userobject非必须
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像
├─ level_namestring非必须等级名
├─ level_ratestring非必须等级分红比例%
├─ conditionstring非必须当前用户达到的条件值
├─ is_big_rateinteger必须1是最高分红等级,0否
├─ up_typenumber非必须1下线总人数,2累计佣金总额,3已提现佣金总额,4合伙人订单总数,5合伙人订单总金额
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ namestring必须等级名
├─ bonus_ratestring必须分红比例%
├─ conditionstring必须条件值
├─ is_defaultstring必须是否默认
├─ is_deletestring必须
├─ deleted_atstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ is_thisnumber必须1是用户当前的等级
├─ is_upnumber必须1当前用户达到了该等级升级条件

是否符合要求

基本信息

Path: /plugin/stock/api/index/index

Method: GET

接口描述:

all_children:下线总人数
all_order:合伙人订单总数
all_money:合伙人订单总金额
cash_money:已提现佣金金额
total_money:累计佣金金额

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber必须
dataobject必须
├─ all_childrennumber非必须
├─ passboolean非必须true:通过 false:未达标
├─ conditionnumber非必须条件

查看审核状态|获取股东信息

基本信息

Path: /plugin/stock/api/index/apply-status

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber必须
msgstring必须
dataobject必须
├─ stockobject非必须
├─ idstring非必须股东id
├─ mall_idstring非必须商城id
├─ user_idstring非必须用户id
├─ level_idstring非必须等级id
├─ statusstring非必须-1:再次申请未申请 0:申请中 1:成功 2:拒绝
├─ is_deletestring非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ applyed_atstring非必须申请时间
├─ agreed_atstring非必须通过时间
├─ all_bonusstring非必须累计分红
├─ total_bonusstring非必须当前分红
├─ out_bonusstring非必须
├─ avatarstring非必须头像
├─ levelobject非必须等级
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ bonus_ratestring非必须
├─ conditionstring非必须
├─ is_defaultstring非必须
├─ is_deletestring非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ userobject非必须股东信息
├─ nicknamestring非必须
├─ idstring非必须
├─ usernamestring非必须
├─ mobilestring非必须
├─ mall_idstring非必须
├─ bonus_ratestring非必须
├─ cash_bonusstring非必须已体现分红

清除申请信息

基本信息

Path: /plugin/stock/api/index/clear-apply

Method: POST

接口描述:

当被拒绝或者移除股东后,请求该接口

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
datastring非必须

申请提现

基本信息

Path: /plugin/stock/api/index/cash

Method: POST

接口描述:
undefined

请求参数

申请股东

基本信息

Path: /plugin/stock/api/index/apply

Method: POST

接口描述:

当股东设置申请成为股东为  “申请(不填信息)需审核” || ”申请(不填信息)无需审核“      apply_type == 3  或者  4时, name 和 mobile不用填

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
is_agree text 是 1 是否同意
name text 是 wwww 姓名
mobile text 是 13131313131 手机号

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

N元任选--插件

下单提交

基本信息

Path: /plugin/pick/api/pick-order/order-submit

Method: GET

接口描述:

请求参数

下单预览

基本信息

Path: /plugin/pick/api/pick-order/order-preview

Method: GET

接口描述:

请求参数

凑单池列表

基本信息

Path: /plugin/pick/api/cart/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
limit 否
page 否

返回数据

名称类型是否必须默认值备注其他信息

凑单池删除

基本信息

Path: /plugin/pick/api/cart/delete

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cart_id_list 是

凑单池添加

基本信息

Path: /plugin/pick/api/cart/add

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
goods_id 是
attr 是
num 是

返回数据

名称类型是否必须默认值备注其他信息

凑单池编辑

基本信息

Path: /plugin/pick/api/cart/edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
list 是

商品列表

基本信息

Path: /plugin/pick/api/index/goods-list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ goods_warehouse_idstring必须
├─ statusstring必须
├─ pricestring必须
├─ use_attrstring必须
├─ attr_groupsstring必须
├─ goods_stockstring必须
├─ virtual_salesstring必须
├─ confine_countstring必须
├─ piecesstring必须
├─ foreheadstring必须
├─ freight_idstring必须
├─ give_integralstring必须
├─ give_integral_typestring必须
├─ forehead_integralstring必须
├─ forehead_integral_typestring必须
├─ accumulativestring必须
├─ individual_sharestring必须
├─ attr_setting_typestring必须
├─ is_levelstring必须
├─ is_level_alonestring必须
├─ share_typestring必须
├─ signstring必须
├─ app_share_picstring必须
├─ app_share_titlestring必须
├─ is_default_servicesstring必须
├─ sortstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ payment_peoplestring必须
├─ payment_numstring必须
├─ payment_amountstring必须
├─ payment_orderstring必须
├─ confine_order_countstring必须
├─ is_area_limitstring必须
├─ area_limitstring必须
├─ form_idstring必须
├─ gppds_stockstring必须
├─ goodsWarehouseobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attrobject []必须

item 类型: object

├─ idstring必须
├─ goods_idstring必须
├─ sign_idstring必须
├─ stockstring必须
├─ pricestring必须
├─ nostring必须
├─ weightstring必须
├─ pic_urlstring必须
├─ is_deletestring必须
├─ integralMallGoodsnull必须
├─ cover_picstring必须
├─ namestring必须
├─ original_pricestring必须
├─ salesstring必须
├─ activityobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ statusnumber非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ titlestring非必须
├─ start_atstring非必须
├─ end_atstring非必须
├─ rule_pricestring非必须
├─ rule_numnumber非必须
├─ is_area_limitnumber非必须
├─ area_limitstring非必须
├─ bg_urlstring非必须
├─ formobject非必须
├─ textobject非必须
├─ colorstring非必须
├─ bgobject非必须
├─ colorstring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

商品详情

基本信息

Path: /plugin/pick/api/index/goods-detail

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ mch_idnumber非必须
├─ goods_warehouse_idnumber非必须
├─ statusnumber非必须
├─ pricestring非必须
├─ use_attrnumber非必须
├─ attr_groupsobject []非必须

item 类型: object

├─ attr_group_idnumber非必须
├─ attr_group_namestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ pic_urlstring非必须
├─ goods_stocknumber非必须
├─ virtual_salesnumber非必须
├─ confine_countnumber非必须
├─ piecesnumber非必须
├─ foreheadstring非必须
├─ freight_idnumber非必须
├─ give_integralnumber非必须
├─ give_integral_typenumber非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typenumber非必须
├─ accumulativenumber非必须
├─ individual_sharenumber非必须
├─ attr_setting_typenumber非必须
├─ is_levelnumber非必须
├─ is_level_alonenumber非必须
├─ share_typenumber非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesnumber非必须
├─ sortnumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ payment_peoplenumber非必须
├─ payment_numnumber非必须
├─ payment_amountstring非必须
├─ payment_ordernumber非必须
├─ confine_order_countnumber非必须
├─ is_area_limitnumber非必须
├─ area_limitstring非必须
├─ form_idnumber非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cover_picstring非必须
├─ unitstring非必须
├─ detailstring非必须
├─ video_urlstring非必须
├─ level_shownumber非必须
├─ is_salesnumber非必须
├─ attrobject []非必须

item 类型: object

├─ idnumber非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stocknumber非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ is_deletenumber非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ price_membernumber非必须
├─ member_price_listobject []非必须

item 类型: object

├─ idnumber必须
├─ levelnumber必须
├─ pricestring必须
├─ goods_attr_idnumber必须
├─ is_deletenumber必须
├─ goods_idnumber必须
├─ goods_numnumber非必须
├─ goods_nostring非必须
├─ goods_weightnumber非必须
├─ servicesstring []非必须

item 类型: string

├─ 非必须
├─ cardsstring []非必须

item 类型: string

├─ 非必须
├─ price_minnumber非必须
├─ price_maxnumber非必须
├─ pic_urlobject []非必须

item 类型: object

├─ pic_urlstring必须
├─ idnumber必须
├─ sharenumber非必须
├─ salesnumber非必须
├─ favoriteboolean非必须
├─ goods_marketingobject非必须
├─ limitstring非必须
├─ pickupstring非必须
├─ shippingstring非必须
├─ goods_marketing_awardobject非必须
├─ cardobject非必须
├─ titlestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ integralobject非必须
├─ titlestring非必须
├─ vip_card_appointobject非必须
├─ discountnull非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ expressstring非必须
├─ group_min_member_pricenumber非必须
├─ group_max_member_pricenumber非必须

海报

基本信息

Path: /plugin/pick/api/index/poster

Method: GET

接口描述:
undefined

请求参数

套餐组合

套餐详情

基本信息

Path: /composition/api/index/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 页码
goods_id 是 商品id
composition_id 是 展示的套餐id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须套餐列表

item 类型: object

├─ idnumber必须套餐id
├─ namestring必须套餐名称
├─ typenumber必须套餐类型

枚举: 1,2

枚举备注: 1--固定套餐 2--搭配套餐

├─ type_textstring必须套餐类型中文释义
├─ pricestring必须优惠金额(仅对固定套餐有效)
├─ stocknumber必须套餐剩余库存
├─ host_listobject []必须主商品列表(仅对搭配套餐有效)同goods_list

item 类型: object

├─ idnumber非必须套餐商品id
├─ goods_idnumber非必须商品id
├─ namestring非必须商品名称
├─ cover_picstring非必须商品封面图
├─ is_hostnumber非必须是否是主商品
├─ min_pricestring非必须商品最低价(仅对搭配套餐有效)
├─ attr_groupsobject []非必须商品规格组

item 类型: object

├─ attr_group_idnumber非必须
├─ attr_group_namestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ goods_attrobject []非必须商品规格信息

item 类型: object

├─ attr_listobject []非必须规格列表

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ pricestring非必须规格价格
├─ stocknumber非必须库存
├─ goods_attr_idnumber非必须规格id
├─ goods_listobject []必须套餐商品列表

item 类型: object

├─ idnumber必须套餐商品id
├─ goods_idnumber必须商品id
├─ namestring必须商品名称
├─ cover_picstring必须商品封面图
├─ is_hostnumber必须是否是主商品
├─ min_pricestring必须商品最低价
├─ attr_groupsobject []必须商品规格组

item 类型: object

├─ attr_group_idnumber必须
├─ attr_group_namestring必须
├─ attr_listobject []必须

item 类型: object

├─ attr_idnumber必须
├─ attr_namestring必须
├─ pic_urlstring必须
├─ goods_attrobject []必须商品规格信息

item 类型: object

├─ attr_listobject []必须规格列表

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ pricestring,number必须规格价格
├─ stocknumber必须规格库存
├─ goods_attr_idnumber必须规格id
├─ pricenumber必须优惠金额
├─ detailobject必须
├─ idinteger必须商品id
├─ pricestring必须商品售价
├─ attrobject []必须同goods_attr

item 类型: object

├─ signstring必须商品标示
├─ cover_picstring必须商品封面图
├─ goods_numstring必须商品总库存
├─ host_pricestring,number必须主商品优惠金额(仅对搭配套餐有效)
├─ min_pricestring,number必须搭配商品最低优惠金额(仅对搭配套餐有效)
├─ max_pricenumber必须搭配商品最高优惠金额(仅对搭配套餐有效)
├─ max_discountnumber必须最多可优惠金额
├─ min_composition_pricenumber必须最小套餐价

套餐配置

基本信息

Path: /composition/api/index/config

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
dataobject必须
├─ titlestring必须规则标题
├─ rulestring必须规则内容
├─ activeBgstring必须背景图

活动主页

基本信息

Path: /composition/api/index/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 页码
keyword 否 商品名称

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须套餐列表

item 类型: object

├─ idnumber必须套餐id
├─ namestring必须套餐名称
├─ typenumber必须套餐类型

枚举: 1,2

枚举备注: 1--固定套餐 2--搭配套餐

├─ type_textstring必须套餐类型中文释义
├─ pricestring必须优惠金额(仅固定套餐有效)
├─ stocknumber必须剩余库存
├─ created_atstring必须添加时间
├─ goods_listobject []必须商品列表

item 类型: object

├─ idnumber必须套餐商品id
├─ goods_idnumber必须商品id
├─ namestring必须商品名称
├─ cover_picstring必须商品封面图
├─ is_hostnumber必须是否是主商品(仅对搭配套餐有效)

枚举: 0,1

枚举备注: 0--搭配商品 1--主商品

├─ min_pricestring,number必须规格的最低价
├─ attr_groupsobject []必须规格组

item 类型: object

├─ attr_group_idnumber必须
├─ attr_group_namestring必须
├─ attr_listobject []必须

item 类型: object

├─ attr_idnumber必须
├─ attr_namestring必须
├─ pic_urlstring必须
├─ goods_attrobject []必须商品规格

item 类型: object

├─ attr_listobject []必须规格列表

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ pricestring,number必须套餐价格(仅对搭配套餐有效)
├─ stocknumber必须套餐库存(仅对搭配套餐有效)
├─ goods_attr_idnumber必须规格id
├─ stockinteger必须商品库存
├─ pricestring必须商品优惠金额(仅对搭配套餐有效)
├─ host_pricestring,number必须主商品优惠金额(仅对搭配套餐有效)
├─ min_pricestring,number必须搭配商品最低优惠金额(仅对搭配套餐有效)
├─ max_pricestring必须搭配商品最高优惠金额(仅对搭配套餐有效)
├─ host_listobject []必须主商品列表(仅对搭配套餐有效)数据结构同goods_list

item 类型: object

├─ max_discountnumber必须套餐最多可省

区域代理--插件

判断区域代理状态

基本信息

Path: /plugin/region/api/index/apply-status

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ regionobject非必须
├─ user_idstring非必须用户id
├─ levelstring非必须等级
├─ province_idstring非必须省id
├─ statusstring非必须
├─ is_deletestring非必须
├─ applyed_atstring非必须
├─ agreed_atstring非必须
├─ created_atstring非必须
├─ all_bonusstring非必须
├─ total_bonusstring非必须
├─ out_bonusstring非必须
├─ namestring非必须
├─ phonestring非必须
├─ avatarstring非必须
├─ reasonstring非必须
├─ bonus_ratestring非必须
├─ cash_bonusstring非必须
├─ is_upstring非必须1可升级 0不可升级
├─ level_upobject非必须
├─ typestring非必须1:下线总人数 2:累计佣金总额 3:已提现佣金总额 4:合伙人订单总数 5:合伙人订单总金额 6:消费金额
├─ levelstring非必须等级 1:省 2:市 3:区
├─ level_descstring非必须
├─ now_targetstring非必须当前指标
├─ targetstring非必须目标(条件)指标
├─ passstring非必须是否通过

是否符合要求

基本信息

Path: /plugin/region/api/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
province_id 是 921 省id
level 是 2 1:省代理
2:市代理
3:区代理

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ typenumber非必须1:下线总人数 2:累计佣金总额 3:已提现佣金总额 4:合伙人订单总数 5:合伙人订单总金额 6:消费金额
├─ levelnumber非必须等级 1:省 2:市 3:区
├─ level_descstring非必须
├─ now_targetstring非必须当前指标
├─ targetstring非必须目标(条件)指标
├─ passboolean非必须是否通过

申请代理

基本信息

Path: /plugin/region/api/index/apply

Method: POST

接口描述:

level为2时
必须要city_id

level为3时
必须要district_id

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
province_id text 是 921 省id
level text 是 3 1:省代理

2:市代理
3:区代理 |
| is_agree | text | 是 | 1 | 是否同意 |
| mobile | text | 否 | 13131313131 | 电话 |
| name | text | 否 | wjjjjj | 姓名 |
| district_id[] | text | 否 | 966 | 区id |
| city_id[] | text | 否 | 965 | 市id |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

申请升级

基本信息

Path: /plugin/region/api/index/level-up

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
level text 是 2 等级

2:升级为市代理
1:升级为省代理 |
| city_id[] | text | 否 | 922 | 市id
level:2时 必填 |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

获取设置

基本信息

Path: /plugin/region/api/index/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ is_regionnumber非必须
├─ region_ratenumber非必须
├─ apply_typestring非必须
├─ is_agreementnumber非必须
├─ agreement_titlestring非必须
├─ agreement_contentstring非必须
├─ user_instructionsstring非必须
├─ level_up_contentstring非必须
├─ pay_typestring []非必须

item 类型: string

├─ 非必须
├─ min_moneynumber非必须
├─ cash_service_chargenumber非必须
├─ free_cash_minstring非必须
├─ formobject非必须
├─ bg_urlstring非必须
├─ entry_bonusstring非必须
├─ titlestring非必须
├─ total_bonusstring非必须
├─ expect_bonusstring非必须
├─ cashd_bonusstring非必须
├─ become_namestring非必须
├─ statics_textstring非必须
├─ price_textstring非必须
├─ can_cash_bonusstring非必须
├─ ordersstring非必须
├─ statistic_bonusstring非必须
├─ bottom_bg_urlstring非必须
├─ membersstring非必须
├─ offer_textstring非必须
├─ audit_result_tplstring []非必须

item 类型: string

├─ 非必须
├─ remove_identity_tplstring []非必须

item 类型: string

├─ 非必须
├─ template_message_regionstring []非必须

item 类型: string

├─ 非必须
├─ template_message_withdrawstring []非必须

item 类型: string

├─ 非必须

电子卡密

卡密使用说明

基本信息

Path: /plugin/ecard/api/index/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
order_id 是 1 订单id

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须
msgstring必须
dataobject必须
├─ contentstring必须卡密使用说明
├─ namestring必须卡密名称

电子卡密列表

基本信息

Path: /plugin/ecard/api/index/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
dataobject []必须

item 类型: object

├─ idstring必须卡密id
├─ namestring必须卡密名称
├─ created_atstring必须卡密添加时间

社区团购--插件

提货通知

基本信息

Path: /plugin/community/api/middleman/notice

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
activity_id 是 活动id

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须

下单提交

基本信息

Path: /plugin/community/api/order/order-submit

Method: GET

接口描述:
undefined

请求参数

分享海报数据获取

基本信息

Path: /plugin/community/api/goods/config

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
goods_id 是

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须
dataobject非必须
├─ configobject非必须
├─ poster_stylestring []非必须海报样式

item 类型: string

├─ 非必须
├─ image_stylestring []非必须商品图片数量

item 类型: string

├─ 非必须
├─ colorstring []非必须颜色

item 类型: string

├─ 非必须
├─ infoobject非必须
├─ goods_namestring非必须商品名称
├─ is_negotiablenumber非必须
├─ min_pricestring非必须最小价格
├─ max_pricestring非必须最高价格
├─ multi_mapstring []非必须商品图片

item 类型: string

├─ 非必须
├─ qrcode_urlstring非必须小程序码
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像
├─ signstring非必须插件标示
codenumber非必须

利润提现

基本信息

Path: /api/finance/cash

Method: POST

接口描述:

提现申请

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
model text 是 提现的插件类型
price text 是 提现金额
name text 是 用户名称
mobile text 是 联系方式
bank_name' text 是 开户行
type text 是 提现方式

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须
msgstring必须
dataobject非必须
├─ queue_idinteger必须
├─ tokenstring必须

利润提现列表

基本信息

Path: /api/finance/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
model 是 community 提现插件的标示
status 是 -1 提现状态 -1--全部 0--申请中 1--同意 2--已打款 3--驳回
page 是 页码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject非必须
├─ 2020-07-02object非必须
├─ datestring非必须时间
├─ listobject []非必须

item 类型: object

├─ idnumber必须提现id
├─ order_nostring必须提现单号
├─ pay_typestring必须提现方式文本
├─ typestring必须提现方式
├─ statusnumber必须提现状态

枚举: 0,1,2,3

枚举备注: 0--申请 1--同意 2--已打款 3--驳回

├─ status_textstring必须提现状态文本
├─ userobject必须用户信息
├─ avatarstring非必须用户头像
├─ nicknamestring非必须用户昵称
├─ platformstring非必须所在平台
├─ cashobject必须提现信息
├─ pricenumber非必须提现金额
├─ service_chargenumber非必须手续费
├─ actual_pricenumber非必须实际打款金额
├─ extraobject必须额外信息
├─ namestring非必须名称
├─ mobilestring非必须联系方式
├─ bank_namestring非必须开户行
├─ timeobject必须时间信息
├─ created_atstring非必须申请时间
├─ apply_atstring非必须审核时间
├─ remittance_atstring非必须打款时间
├─ reject_atstring非必须驳回时间
├─ contentobject必须备注信息
├─ apply_contentstring非必须审核备注
├─ remittance_contentstring非必须打款备注
├─ reject_contentstring非必须驳回备注

利润提现配置

基本信息

Path: /api/finance/config

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
model text 是 community 提现插件标示

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgobject非必须
├─ configobject非必须配置信息
├─ pay_typestring []非必须提现方式

item 类型: string

├─ 非必须
├─ min_moneystring非必须提现门槛
├─ cash_service_chargestring非必须手续费(%)
├─ free_cash_minstring非必须免手续费提现门槛
├─ template_messagestring []非必须提现订阅消息

item 类型: string

├─ 非必须

商品海报获取

基本信息

Path: /plugin/community/api/goods/generate

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
style 是 1 海报样式
typesetting 是 1 商品图数量(排版)
type 是 1 类型
goods_id 是 商品id
color 是 #ff7b22 颜色

返回数据

名称类型是否必须默认值备注其他信息

商品详情

基本信息

Path: /plugin/community/api/goods/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
goods_id 是 商品id
middleman_id 是 团长的user_id
longitude 是 经度
latitude 是 纬度

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须
dataobject非必须
├─ goodsobject非必须商品信息,同商品详情
├─ idnumber非必须
├─ mall_idnumber非必须
├─ mch_idnumber非必须
├─ goods_warehouse_idnumber非必须
├─ statusnumber非必须
├─ pricestring非必须
├─ use_attrnumber非必须
├─ attr_groupsobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ pic_urlstring非必须
├─ goods_stocknumber非必须
├─ virtual_salesnumber非必须
├─ confine_countnumber非必须
├─ piecesnumber非必须
├─ foreheadstring非必须
├─ freight_idnumber非必须
├─ give_integralnumber非必须
├─ give_integral_typenumber非必须
├─ give_balancenumber非必须
├─ give_balance_typenumber非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typenumber非必须
├─ accumulativenumber非必须
├─ individual_sharenumber非必须
├─ attr_setting_typenumber非必须
├─ is_levelnumber非必须
├─ is_level_alonenumber非必须
├─ share_typenumber非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesnumber非必须
├─ sortnumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ payment_peoplenumber非必须
├─ payment_numnumber非必须
├─ payment_amountstring非必须
├─ payment_ordernumber非必须
├─ confine_order_countnumber非必须
├─ is_area_limitnumber非必须
├─ area_limitstring非必须
├─ form_idnumber非必须
├─ salesnumber非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cover_picstring非必须
├─ unitstring非必须
├─ detailstring非必须
├─ video_urlstring非必须
├─ level_shownumber非必须
├─ is_salesnumber非必须
├─ attrobject []非必须

item 类型: object

├─ idstring非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stockstring非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ is_deletenumber非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ price_membernumber非必须
├─ member_price_listobject []非必须

item 类型: object

├─ idstring必须
├─ levelnumber必须
├─ pricestring必须
├─ goods_attr_idnumber必须
├─ is_deletenumber必须
├─ goods_idnumber必须
├─ goods_numnumber非必须
├─ goods_nostring非必须
├─ goods_weightnumber非必须
├─ servicesstring []非必须

item 类型: string

├─ 非必须
├─ cardsstring []非必须

item 类型: string

├─ 非必须
├─ price_minnumber非必须
├─ price_maxnumber非必须
├─ pic_urlobject []非必须

item 类型: object

├─ pic_urlstring非必须
├─ idnumber非必须
├─ sharenumber非必须
├─ favoriteboolean非必须
├─ goods_marketingobject非必须
├─ limitstring非必须
├─ pickupstring非必须
├─ shippingstring非必须
├─ goods_marketing_awardobject非必须
├─ cardobject非必须
├─ titlestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ integralobject非必须
├─ titlestring非必须
├─ vip_card_appointobject非必须
├─ discountnull非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ plugin_extraobject非必须
├─ compositionobject非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ urlstring非必须
├─ expressstring非必须
├─ catsstring []非必须

item 类型: string

├─ 非必须
├─ middlemanobject非必须团长信息,同团长详情
├─ idnumber非必须团长id
├─ user_idnumber非必须团长user_id
├─ namestring非必须团长名称
├─ mobilestring非必须团长联系方式
├─ locationstring非必须小区名称
├─ provincestring非必须省份
├─ citystring非必须城市
├─ districtstring非必须地区
├─ detailstring非必须地址
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像
├─ activityobject非必须活动信息
├─ start_atstring非必须开始时间
├─ statusinteger非必须状态

枚举: 0,1,2

枚举备注: 0--未开始 1--进行中 2--已结束

├─ timestring非必须时间戳
├─ end_atstring非必须结束时间
├─ titlestring非必须活动标题
codenumber非必须

团长信息修改

基本信息

Path: /plugin/community/api/middleman/edit-address

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
detail text 是 提货地址

返回数据

名称类型是否必须默认值备注其他信息

团长列表

基本信息

Path: /plugin/community/api/middleman/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
longitude 是 经度
latitude 是 纬度
page 是 页码

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
dataobject []必须

item 类型: object

├─ listobject []必须

item 类型: object

├─ idinteger必须团长id
├─ user_idinteger必须团长用户id
├─ namestring必须联系人
├─ mobilestring必须联系方式
├─ locationstring必须小区名称
├─ provincestring必须省份
├─ citystring必须城市
├─ districtstring必须地区
├─ detailstring必须提货地址
├─ nicknamestring必须昵称
├─ avatarstring必须头像
├─ distancenumber必须距离(m)

团长利润列表

基本信息

Path: /plugin/community/api/middleman/profit-list

Method: GET

接口描述:
undefined

请求参数

团长利润详情

基本信息

Path: /plugin/community/api/middleman/profit-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 活动ID
type 是 month当月,day今日

返回数据

名称类型是否必须默认值备注其他信息

团长活动列表

基本信息

Path: /plugin/community/api/activity/list

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
status text 是 -1全部,0未开始,1进行中,2已结束,3下架中
page text 是

返回数据

名称类型是否必须默认值备注其他信息

团长活动数据

基本信息

Path: /plugin/community/api/activity/log

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 活动ID
page text 是

团长活动详情

基本信息

Path: /plugin/community/api/activity/detail

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 活动ID

团长订单列表

基本信息

Path: /plugin/community/api/order/middle-list

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
keyword text 是

团长订单详情

基本信息

Path: /plugin/community/api/order/middle-detail

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 订单ID

下单预览

基本信息

Path: /plugin/community/api/order/order-preview

Method: GET

接口描述:
undefined

请求参数

活动商品开关

基本信息

Path: /plugin/community/api/goods/switch

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
activity_id text 是 活动ID
goods_id text 是 商品ID

返回数据

名称类型是否必须默认值备注其他信息

活动海报

基本信息

Path: /plugin/community/api/activity/poster-config

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
activity_id 是 活动id
middleman_id 是 团长user_id

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须
dataobject非必须
├─ configobject非必须
├─ activity_poster_stylestring []非必须样式

item 类型: string

├─ 非必须
├─ image_bgstring非必须背景图
├─ colorstring []非必须可选颜色

item 类型: string

├─ 非必须
├─ infoobject非必须
├─ nicknamestring非必须用户昵称
├─ avatarstring非必须用户头像
├─ activityobject非必须
├─ titlestring非必须活动标题
├─ goods_listobject []非必须商品列表(最多6个)

item 类型: object

├─ cover_picstring必须封面图
├─ namestring必须名称
├─ original_pricestring必须原价(划线价)
├─ pricestring必须售价
├─ end_atstring非必须活动结束时间
├─ start_atstring非必须开始时间
├─ qrcodestring非必须小程序码
├─ middlemanobject非必须
├─ namestring非必须团长名称
├─ mobilestring非必须团长联系方式
├─ avatarstring非必须团长头像
├─ provincestring非必须省
├─ citystring非必须市
├─ districtstring非必须区
├─ detailstring非必须提货地址
├─ locationstring非必须小区地址
codenumber非必须

添加购物车

基本信息

Path: /plugin/community/api/cart/add

Method: GET

接口描述:

购物车编辑使用队列方式处理数据

请求参数

Query

参数名称 是否必须 示例 备注
activity_id 是 活动id
goods_id 是 商品id
goods_attr_id 是 商品规格id
num 是 商品数量

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
dataobject非必须
├─ tokenstring非必须用于购物车添加结果接口
├─ queue_idinteger非必须用于购物车添加结果接口

用户活动详情

基本信息

Path: /plugin/community/api/activity/user-activity

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 活动ID
page 是

申请成为团长

基本信息

Path: /plugin/community/api/middleman/apply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 团长昵称
mobile text 是 联系电话
province_id text 是 省份id
city_id text 是 城市id
district_id text 是 地区id
detail text 是 提货地址
latitude text 是 经度
longitude text 是 纬度
location text 是 小区名称

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
dataobject非必须
├─ tokenstring非必须申请结果接口参数
├─ queue_idinteger非必须申请结果接口参数

申请结果

基本信息

Path: /plugin/community/api/middleman/apply-result

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
token 是
queue_id 是

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
dataobject非必须
├─ idstring非必须

绑定团长

基本信息

Path: /plugin/community/api/middleman/bind

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
middleman_id 是 团长user_id

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

获取团长信息

基本信息

Path: /plugin/community/api/middleman/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须
dataobject非必须
├─ settingobject非必须同设置
├─ is_applynumber非必须
├─ is_apply_moneynumber非必须
├─ is_allow_changenumber非必须
├─ apply_moneynumber非必须
├─ apply_money_namestring非必须
├─ middlemanstring非必须
├─ sell_out_sortnumber非必须
├─ app_share_titlestring非必须
├─ app_share_picstring非必须
├─ bannerstring非必须
├─ recruit_titlestring非必须
├─ recruit_contentstring非必须
├─ middlemanobject非必须
├─ moneynumber非必须可提现利润
├─ total_moneynumber非必须累计利润
├─ statusinteger非必须团长状态

枚举: -1,0,1,2

枚举备注: -1--未支付申请费 0--申请中,待审核 1--审核通过 2--审核后拒绝

├─ delete_first_showinteger非必须团长删除后是否显示解除提示

枚举: 0,1

枚举备注: 0--不显示 1--显示

├─ namestring非必须团长昵称
├─ moblestring非必须团长联系方式
├─ province_idinteger非必须省份id
├─ provincestring非必须省份名称
├─ city_idinteger非必须城市id
├─ citystring非必须城市名称
├─ district_idinteger非必须地区id
├─ districtstring非必须地区名称
├─ detailstring非必须提货地址
├─ latitudestring非必须经度
├─ longitudestring非必须纬度
├─ locationstring非必须小区名称
├─ become_atstring非必须加入时间(成为团长时间)
codenumber非必须

获取支付id

基本信息

Path: /plugin/community/api/middleman/apply-pay

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 团长id

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
dataobject非必须
├─ idstring非必须支付id

订单列表

基本信息

Path: /plugin/community/api/order/list

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
keyword text 是

订单详情

基本信息

Path: /plugin/community/api/order/detail

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 订单ID

设置

基本信息

Path: /plugin/community/api/index/setting-data

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ is_applynumber非必须是否开启团长审核

枚举: 0,1

枚举备注: 0--不需要 1--需要

├─ is_apply_moneynumber非必须是否开启申请门槛

枚举: 0,1

枚举备注: 0--不开启 1--开启

├─ is_allow_changenumber非必须是否允许更换团长

枚举: 0,1

枚举备注: 0--不允许 1--允许

├─ apply_moneynumber非必须门槛金额
├─ apply_money_namestring非必须门槛金额名称
├─ middlemanstring非必须社区团购团长名称
├─ sell_out_sortnumber非必须售罄商品显示方式

枚举: 1,2,3

枚举备注: 1--显示 2--隐藏 3--显示且自动排在最后

├─ app_share_titlestring非必须分享标题
├─ app_share_picstring非必须分享图片
├─ bannerstring非必须背景图
├─ recruit_titlestring非必须招募令标题
├─ recruit_contentstring非必须招募令内容

购物车列表

基本信息

Path: /plugin/community/api/cart/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
middleman_id 是 团长id
activity_id 是 活动id

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
dataobject非必须
├─ activity_namestring非必须活动名称
├─ listobject []非必须商品列表

item 类型: object

├─ activity_idinteger非必须活动id
├─ community_goods_idinteger非必须社区团购商品id
├─ goods_idinteger非必须商品id
├─ goods_attr_idinteger非必须商品规格id
├─ numinteger非必须商品数量
├─ namestring非必须商品名称
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须规格名称
├─ attr_namestring非必须规格值
├─ pic_urlstring非必须图片
├─ pricestring非必须价格
├─ is_existstring非必须是否有效

枚举: 0,1

枚举备注: 0--无效 1--有效

├─ idstring非必须购物车id

购物车删除

基本信息

Path: /plugin/community/api/cart/delete

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cart_id_list 是 购物车id列表 例:'[1,2,3]'

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

购物车批量编辑

基本信息

Path: /plugin/community/api/cart/edit

Method: GET

接口描述:

购物车编辑使用队列方式处理数据

请求参数

Query

参数名称 是否必须 示例 备注
list 是 数据结构同购物车列表

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
dataobject非必须
├─ tokenstring非必须用于购物车添加结果接口
├─ queue_idstring非必须用于购物车添加结果接口

购物车添加结果

基本信息

Path: /plugin/community/api/cart/add-result

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
token text 是
queue_id text 是

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
msgstring非必须
dataobject非必须
├─ retryinteger非必须重新请求改接口

限时抢购

加入购物车

基本信息

Path: /plugin/flash_sale/api/index/add-cart

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
flash_goods_id text 是 212 限时抢购商品id
attr_id text 是 2685 商品attr_id
num text 是 1 数量

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

商品详情

基本信息

Path: /plugin/flash_sale/api/index/goods-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 212 限时抢购商品id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ mch_idnumber非必须
├─ goods_warehouse_idnumber非必须
├─ statusnumber非必须
├─ pricestring非必须
├─ use_attrnumber非必须
├─ attr_groupsobject []非必须

item 类型: object

├─ attr_group_idnumber非必须
├─ attr_group_namestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ pic_urlstring非必须
├─ goods_stocknumber非必须
├─ virtual_salesnumber非必须
├─ confine_countnumber非必须
├─ piecesnumber非必须
├─ foreheadstring非必须
├─ freight_idnumber非必须
├─ give_integralnumber非必须
├─ give_integral_typenumber非必须
├─ give_balancenumber非必须
├─ give_balance_typenumber非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typenumber非必须
├─ accumulativenumber非必须
├─ individual_sharenumber非必须
├─ attr_setting_typenumber非必须
├─ is_levelnumber非必须
├─ is_level_alonenumber非必须
├─ share_typenumber非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesnumber非必须
├─ sortnumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ payment_peoplenumber非必须
├─ payment_numnumber非必须
├─ payment_amountstring非必须
├─ payment_ordernumber非必须
├─ confine_order_countnumber非必须
├─ is_area_limitnumber非必须
├─ area_limitstring非必须
├─ form_idnumber非必须
├─ salesnumber非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cover_picstring非必须
├─ unitstring非必须
├─ detailstring非必须
├─ video_urlstring非必须
├─ level_shownumber非必须
├─ is_salesnumber非必须
├─ attrobject []非必须

item 类型: object

├─ idnumber非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stocknumber非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ is_deletenumber非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ price_memberstring非必须
├─ member_price_liststring []非必须

item 类型: string

├─ 非必须
├─ attrobject非必须
├─ idnumber非必须
├─ discountstring非必须
├─ cutstring非必须
├─ sale_pricestring非必须
├─ typenumber非必须
├─ goods_idnumber非必须
├─ goods_attr_idnumber非必须
├─ is_deletenumber非必须
├─ goods_numnumber非必须
├─ goods_nostring非必须
├─ goods_weightnumber非必须
├─ servicesstring []非必须

item 类型: string

├─ 非必须
├─ cardsstring []非必须

item 类型: string

├─ 非必须
├─ price_minnumber非必须
├─ price_maxnumber非必须
├─ pic_urlobject []非必须

item 类型: object

├─ idstring非必须
├─ pic_urlstring非必须
├─ sharenumber非必须
├─ favoriteboolean非必须
├─ goods_marketingobject非必须
├─ limitstring非必须
├─ pickupstring非必须
├─ shippingstring非必须
├─ goods_marketing_awardobject非必须
├─ cardobject非必须
├─ titlestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ integralobject非必须
├─ titlestring非必须
├─ vip_card_appointobject非必须
├─ discountnull非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ plugin_extraobject非必须
├─ flash_salestring []非必须

item 类型: string

├─ 非必须
├─ compositionobject非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ urlstring非必须
├─ expressstring非必须
├─ price_member_maxnumber非必须
├─ price_member_minnumber非必须
├─ activityobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ statusnumber非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ titlestring非必须活动标题
├─ start_atstring非必须开始时间
├─ end_atstring非必须结束时间
├─ noticenumber非必须活动预告 0不进行预告 1立即预告 2开始前N小时进行预告
├─ notice_hoursnumber非必须提前N小时
├─ is_wipe_zeronumber非必须是否抹零 0否 1是
├─ wipe_typenumber非必须1:抹去角和分 2:抹去分
├─ activity_statusnumber非必须

活动列表

基本信息

Path: /plugin/flash_sale/api/index/goods-list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 1 1为正在进行中的活动 2为即将开始的活动
page 否 1
keyword 否 商品标题

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须活动列表

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stocknumber非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ give_balancestring非必须
├─ give_balance_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitstring非必须
├─ form_idstring非必须
├─ salesstring非必须
├─ activity_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ typestring非必须
├─ ecard_idstring非必须
├─ attrobject []非必须

item 类型: object

├─ idstring非必须
├─ goods_idstring非必须
├─ sign_idstring非必须
├─ stockstring非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightstring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ attrobject非必须
├─ idstring非必须
├─ discountstring非必须
├─ cutstring非必须
├─ sale_pricestring非必须
├─ typestring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ is_deletestring非必须
├─ flashSaleGoodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ statusstring非必须
├─ goods_idstring非必须
├─ typestring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ activity_idstring非必须
├─ sortstring非必须
├─ cover_picstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ page_urlstring非必须
├─ activityobject非必须当前进行中的活动
├─ idnumber非必须
├─ mall_idnumber非必须
├─ statusnumber非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ titlestring非必须活动标题
├─ start_atstring非必须开始时间
├─ end_atstring非必须结束时间
├─ noticenumber非必须活动预告 0不进行预告 1立即预告 2开始前N小时进行预告
├─ notice_hoursnumber非必须
├─ is_wipe_zeronumber非必须是否抹零 0否 1是
├─ wipe_typenumber非必须1:抹去角和分 2:抹去分
├─ next_activityobject非必须即将进行的活动
├─ idnumber非必须
├─ mall_idnumber非必须
├─ statusnumber非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ titlestring非必须
├─ start_atstring非必须
├─ end_atstring非必须
├─ noticenumber非必须
├─ notice_hoursnumber非必须
├─ is_wipe_zeronumber非必须
├─ wipe_typenumber非必须
├─ bg_urlstring非必须
├─ formobject非必须
├─ titlenumber非必须
├─ contentstring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

商品批发

商品列表

基本信息

Path: /plugin/wholesale/api/goods/index

Method: GET

接口描述:
undefined

请求参数

商品详情

基本信息

Path: /plugin/wholesale/api/goods/detail

Method: GET

接口描述:
undefined

请求参数

下单预览

基本信息

Path: /plugin/wholesale/api/order/preview

Method: GET

接口描述:
undefined

请求参数

下单提交

基本信息

Path: /plugin/wholesale/api/order/submit

Method: POST

接口描述:
undefined

请求参数

海报

专题海报

基本信息

Path: /api/qrcode/topic

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 专题id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pic_urlstring非必须

合伙人海报

基本信息

Path: /api/qrcode/share

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pic_urlstring非必须

商品海报

基本信息

Path: /api/qrcode/goods

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
goods_id 是 1 商品id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pic_urlstring非必须

签到

用户设置

基本信息

Path: /check_in/api/index/user

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
is_remind 是

返回数据

名称类型是否必须默认值备注其他信息

自定义数据

基本信息

Path: /plugin/check_in/api/index/customize

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息

获取签到日期

基本信息

Path: /check_in/api/index/sign-in-day

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
month 是

返回数据

名称类型是否必须默认值备注其他信息

配置

基本信息

Path: /check_in/api/index/index

Method: GET

接口描述:

签到插件配置

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ configobject非必须
├─ statusnumber非必须是否开启签到
├─ is_remindnumber非必须是否开启提醒
├─ timestring非必须提醒时间
├─ normal_typestring非必须普通签到奖励类型integral--积分|balance--余额
├─ normalstring非必须普通签到奖励数量
├─ continueobject []非必须连续签到设置

item 类型: object

├─ daynumber非必须连续签到天数
├─ numbernumber非必须连续签到奖励数量
├─ typestring非必须连续签到奖励类型integral--积分|balance--余额
├─ totalobject []非必须累计签到设置

item 类型: object

├─ daynumber非必须累计签到天数
├─ numbernumber非必须累计签到奖励数量
├─ typestring非必须累计签到奖励类型integral--积分|balance--余额
├─ rulestring非必须签到规则
├─ check_inuserobject非必须
├─ continue_daynumber非必须连续签到天数
├─ total_daynumber非必须累计签到天数
├─ is_remindstring非必须是否开启提醒0--未开启 1--开启
├─ today_check_instring非必须今天签到信息
├─ check_in_daystring []非必须签到的日期

item 类型: string

├─ 非必须

领取奖励

基本信息

Path: /check_in/api/index/sign-in

Method: GET

接口描述:

领取奖励

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
status 是 1--普通签到奖励 2--连续签到奖励 3--累计签到奖励
day 是 普通签到天数未1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ queueIdstring非必须
├─ tokenstring非必须

领取奖励结果

基本信息

Path: /check_in/api/index/sign-in-result

Method: GET

接口描述:

签到结果

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
queueId 是
token 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ numberstring非必须奖励数量
├─ typestring非必须奖励类型integral--积分|balance--余额
├─ daynumber非必须签到天数
├─ statusnumber非必须1--普通签到奖励 2--连续签到奖励 3--累计签到奖励

九宫格--抽奖

海报

基本信息

Path: /plugin/pond/api/pond/poster

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pic_urlstring非必须图片

抽奖

基本信息

Path: /plugin/pond/api/pond/lottery

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ opptynumber非必须剩余次数
├─ idnumber非必须奖品id

活动列表

基本信息

Path: /plugin/pond/mall/pond/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
start_at 是 活动开始时间
end_at 是 活动结束时间
status 是 -1 -1:全部
0:未开始
1:进行中
2:已结束
3:下架中
keyword 是 搜索关键字
keyword_label 是 title 搜索类型
活动名称:title

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须商城id
├─ statusstring必须状态 0关闭 1开启
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ titlestring必须活动名称
├─ start_atstring必须开始时间
├─ end_atstring必须结束时间
├─ deplete_integral_numstring必须消耗积分
├─ pond_typestring必须1.天 2.用户 默认为2
├─ opptystring必须抽奖次数
├─ hint_textstring必须未中奖提示
├─ lottery_countstring必须抽奖人数
├─ prize_countstring必须中奖人数
├─ pondobject []必须九宫格奖品

item 类型: object

├─ idstring必须
├─ mall_idstring必须商城id
├─ namestring必须名称
├─ typestring必须1.红包2.优惠卷3.积分4.实物.5.无
├─ probabilitystring必须概率
├─ goods_idstring必须商品id
├─ numstring必须积分数量
├─ pricestring必须红包价格
├─ image_urlstring必须图片
├─ coupon_idstring必须优惠券
├─ stockstring必须库存
├─ created_atstring必须
├─ updated_atstring必须
├─ pond_activity_idstring必须活动id
├─ is_deletestring必须
├─ couponnull必须
├─ goodsnull必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

活动记录

基本信息

Path: /plugin/pond/mall/log/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 否 1 活动id 不传时返回所有

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ pond_idstring必须活动id
├─ user_idstring必须用户id
├─ statusstring必须 0预领取 1 未领取 2 已领取
├─ typestring必须1.红包2.优惠卷3.积分4.实物5无
├─ numstring必须积分数量
├─ detailstring必须优惠券信息
├─ goods_idstring必须商品id
├─ pricestring必须价格
├─ order_idstring必须订单id
├─ raffled_atstring必须
├─ created_atstring必须
├─ pond_activity_idstring必须
├─ couponnull必须
├─ goodsnull必须
├─ userobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ nicknamestring必须
├─ avatarstring必须
├─ namestring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

活动详情

基本信息

Path: /plugin/pond/mall/pond/edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 活动id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ activityobject非必须活动
├─ idstring非必须
├─ mall_idstring非必须商城id
├─ statusstring非必须0关闭 1开启
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ titlestring非必须活动名称
├─ start_atstring非必须开始时间
├─ end_atstring非必须结束时间
├─ deplete_integral_numstring非必须消耗积分
├─ pond_typestring非必须1天 2用户 默认为2
├─ opptystring非必须抽奖次数
├─ hint_textstring非必须未中奖提示语
├─ pondobject []非必须九宫格奖品列表

item 类型: object

├─ idstring,number必须
├─ mall_idstring必须商城id
├─ namestring必须名称
├─ typestring必须1.红包2.优惠卷3.积分4.实物.5.无
├─ probabilitystring必须中将概率
├─ goods_idstring,number必须商品id
├─ numstring,number必须积分数量
├─ pricestring,number必须价格
├─ image_urlstring必须图片
├─ coupon_idnumber必须优惠券
├─ stockstring,number必须库存
├─ created_atstring必须
├─ updated_atstring必须
├─ pond_activity_idstring必须活动id
├─ is_deletestring必须
├─ couponnull必须
├─ goodsnull必须
├─ attr_idnumber必须
├─ couponobject []非必须优惠券列表

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ namestring必须名称
├─ typenumber必须1为折扣券 2为满减券
├─ discountstring必须折扣
├─ discount_limitnull,string必须折扣上限 type为1时有用
├─ pic_urlnumber必须图品
├─ descstring必须描述
├─ min_pricestring必须最小使用金额
├─ sub_pricestring必须满减
├─ total_countnumber必须
├─ sortnumber必须
├─ expire_typenumber必须类型
├─ expire_daynumber必须过期时间
├─ begin_timestring必须开始时间
├─ end_timestring必须结束时间
├─ appoint_typenumber必须
├─ rulestring必须
├─ is_membernumber必须
├─ is_deletenumber必须
├─ deleted_atstring必须
├─ created_atstring必须
├─ updated_atstring必须

新增/编辑活动

基本信息

Path: /plugin/pond/mall/pond/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
pond_activity_id text 是 19 无 为新增 有为编辑
title text 是 tersst 活动名称
start_at text 是 2019-11-18 15 开始时间
end_at text 是 2019-11-19 15 结束时间
hint_text text 是 谢谢惠4顾~ 未中奖提示语
oppty text 是 30 抽奖次数
scratch_type text 是 2 1:天 2:用户 默认为2
deplete_integral_num text 是 0 积分抵扣值
status text 是 1 0关闭 1开启
prize[0][probability] text 是 10
prize[0][type] text 是 1
prize[0][stock] text 是 100
prize[0][goods_id] text 是 33
prize[1][probability] text 是 10
prize[1][type] text 是 3
prize[1][stock] text 是 80
prize[1][integral_num] text 是 5
prize[0][sign_id] text 是 1
prize[0][price] text 是 111

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

订单提交

基本信息

Path: /plugin/pond/api/pond/order-submit

Method: GET

接口描述:
undefined

请求参数

订单预览

基本信息

Path: /plugin/pond/api/pond/order-preview

Method: GET

接口描述:
undefined

请求参数

记录

基本信息

Path: /plugin/pond/api/pond/prize

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页面

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须记录id
├─ mall_idstring非必须
├─ pond_idstring非必须抽奖id
├─ user_idstring非必须
├─ statusstring非必须 0未领取1 已领取
├─ typestring非必须1.红包2.优惠卷3.积分4.实物.5.无
├─ numstring非必须积分数
├─ detailstring非必须积分详情
├─ goods_idstring非必须商品id
├─ pricestring非必须价格
├─ order_idstring非必须实物订单id
├─ raffled_atstring非必须领取时间
├─ created_atstring非必须
├─ goodsnull非必须商品信息
├─ couponnull非必须优惠券信息
├─ namestring非必须名称

配置

基本信息

Path: /plugin/pond/api/pond/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ settingobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ titlestring非必须小程序标题
├─ typenumber非必须1.天 2 用户
├─ probabilitynumber非必须概率
├─ opptynumber非必须抽奖次数
├─ start_atstring非必须开始时间
├─ end_atstring非必须结束时间
├─ deplete_integral_numnumber非必须消耗积分
├─ rulestring非必须规则
├─ created_atstring非必须
├─ updated_atstring非必须
├─ payment_typestring []非必须支付方式

item 类型: string

├─ 非必须
├─ send_typestring []非必须发货方式

item 类型: string

├─ 非必须
├─ is_smsnumber非必须开启短信提醒0关闭 1开启
├─ is_mailnumber非必须开启邮件提醒0关闭 1开启
├─ is_printnumber非必须开启打印0关闭 1开启

首页

基本信息

Path: /plugin/pond/api/pond/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ opptynumber非必须剩余机会
├─ settingobject非必须详见配置
├─ idnumber非必须
├─ mall_idnumber非必须
├─ titlestring非必须
├─ typenumber非必须
├─ probabilitynumber非必须
├─ opptynumber非必须
├─ start_atstring非必须
├─ end_atstring非必须
├─ deplete_integral_numnumber非必须
├─ rulestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ payment_typestring []非必须

item 类型: string

├─ 非必须
├─ send_typestring []非必须

item 类型: string

├─ 非必须
├─ is_smsnumber非必须
├─ is_mailnumber非必须
├─ is_printnumber非必须
├─ listobject []非必须奖品列表

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ namestring必须名称
├─ typestring必须1.红包2.优惠卷3.积分4.实物.5.无
├─ goods_idstring必须商品id
├─ numstring必须积分数
├─ pricestring必须价格
├─ image_urlstring必须图片
├─ coupon_idstring必须优惠券id
├─ stockstring必须库存
├─ created_atstring必须
├─ updated_atstring必须
├─ goodsobject,null必须商品信息
├─ couponobject必须优惠券信息
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ typestring非必须
├─ discountstring非必须
├─ discount_limitnull非必须
├─ pic_urlstring非必须
├─ descstring非必须
├─ min_pricestring非必须
├─ sub_pricestring非必须
├─ total_countstring非必须
├─ sortstring非必须
├─ expire_typestring非必须
├─ expire_daystring非必须
├─ begin_timestring非必须
├─ end_timestring非必须
├─ appoint_typestring非必须
├─ rulestring非必须
├─ is_memberstring非必须
├─ is_deletestring非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须

刮刮卡--插件

订单提交

基本信息

Path: /plugin/scratch/api/scratch/order-submit

Method: GET

接口描述:
undefined

请求参数

中奖名单数据

基本信息

Path: /plugin/scratch/api/scratch/record

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ scratch_idstring必须
├─ user_idstring必须
├─ statusstring必须 0预领取 1 未领取 2 已领取
├─ typestring必须1.红包2.优惠卷3.积分4.实物5无
├─ numstring必须积分数量
├─ pricestring必须价格
├─ order_idstring必须
├─ goods_idstring必须
├─ raffled_atstring必须
├─ created_atstring必须
├─ is_deletestring必须
├─ deleted_atstring必须
├─ scratch_activity_idstring必须活动id
├─ create_timestring必须时间
├─ goodsobject必须商品信息
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userstring必须用户名
├─ couponnull必须优惠券信息
├─ namestring必须奖品名称

活动列表

基本信息

Path: /plugin/scratch/mall/scratch/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
start_at 否 活动开始时间
end_at 否 活动结束时间
status 否 -1 -1:全部
0:未开始
1:进行中
2:已结束
3:下架中
keyword 是 搜索关键字
keyword_label 是 搜索类型
活动名称:title

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须商城id
├─ statusstring非必须状态 0关闭 1开启
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ titlestring非必须活动名称
├─ start_atstring非必须开始时间
├─ end_atstring非必须结束时间
├─ deplete_integral_numstring非必须消耗积分
├─ scratch_typestring非必须1:天 2:用户 默认为2
├─ opptystring非必须抽奖次数
├─ hint_textstring非必须未中奖提示语
├─ lottery_countstring非必须抽奖人数
├─ prize_countstring非必须中奖人数
├─ scratchobject []非必须奖品列表

item 类型: object

├─ idstring必须奖品id
├─ mall_idstring必须商品id
├─ typestring必须1.红包2.优惠卷3.积分4.实物.5.无
├─ probabilitystring必须概率
├─ statusstring必须状态 0 关闭 1开启
├─ goods_idstring必须商品id
├─ numstring必须积分数量
├─ pricestring必须红包价格
├─ coupon_idstring必须优惠券
├─ stockstring必须库存
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ scratch_activity_idstring必须活动id
├─ couponnull必须卡券详情
├─ goodsnull必须商品详情
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

活动数据

基本信息

Path: /plugin/scratch/mall/log/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 否 1 活动id 不传则返回全部活动抽奖记录

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须抽奖记录

item 类型: object

├─ idstring必须
├─ mall_idstring必须商城id
├─ scratch_idstring必须奖品id
├─ user_idstring必须用户id
├─ statusstring必须 0预领取 1 未领取 2 已领取
├─ typestring必须1.红包2.优惠卷3.积分4.实物5无
├─ numstring必须积分数量
├─ detailstring必须优惠券信息
├─ pricestring必须价格
├─ order_idstring必须订单id
├─ goods_idstring必须商品id
├─ raffled_atstring必须
├─ created_atstring必须
├─ is_deletestring必须
├─ deleted_atstring必须
├─ scratch_activity_idstring必须活动id
├─ couponnull必须
├─ goodsnull必须
├─ nicknamestring必须
├─ avatarstring必须
├─ namestring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

添加/编辑活动

基本信息

Path: /plugin/scratch/mall/scratch/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
scratch_activity_id text 否 1 无 为新增 有为编辑
title text 是 这是活动名称啊 活动名称
start_at text 是 2019-11-07 15:53:23 开始时间
end_at text 是 2019-11-17 15:53:23 结束时间
hint_text text 是 谢谢惠顾~ 未中奖提示语
oppty text 是 30 抽奖次数
scratch_type text 是 2 1:天 2:用户 默认为2
deplete_integral_num text 是 0 积分抵扣值
status text 是 1 0关闭 1开启
prize[0][probability] text 是 10
prize[0][type] text 是 1
prize[0][stock] text 是 100
prize[0][price] text 是 5
prize[1][probability] text 是 10
prize[1][type] text 是 3
prize[1][stock] text 是 80
prize[1][integral_num] text 是 5

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

刮刮卡海报

基本信息

Path: /plugin/scratch/api/scratch/poster

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pic_urlstring非必须图片

订单预览

基本信息

Path: /plugin/scratch/api/scratch/order-preview

Method: GET

接口描述:
undefined

请求参数

记录

基本信息

Path: /plugin/scratch/api/scratch/prize

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页面

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ scratch_idstring必须
├─ user_idstring必须
├─ statusstring必须 0预领取 1 未领取 2 已领取
├─ typestring必须1.红包2.优惠卷3.积分4.实物5无
├─ numstring必须积分数
├─ detailstring必须优惠券信息
├─ pricestring必须价格
├─ order_idstring必须
├─ goods_idstring必须
├─ raffled_atstring必须
├─ created_atstring必须
├─ is_deletestring必须
├─ deleted_atstring必须
├─ scratch_activity_idstring必须活动id
├─ goodsobject,null必须商品信息
├─ couponnull必须优惠券信息
├─ attr_listobject []必须规格信息

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ attr_idstring必须规格id
├─ namestring必须奖品名称

配置

基本信息

Path: /plugin/scratch/api/scratch/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ settingobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ titlestring非必须小程序标题
├─ typenumber非必须1.天 2 用户
├─ probabilitynumber非必须概率
├─ opptynumber非必须抽奖次数
├─ start_atstring非必须开始时间
├─ end_atstring非必须结束时间
├─ deplete_integral_numnumber非必须消耗积分
├─ rulestring非必须规则
├─ created_atstring非必须
├─ updated_atstring非必须
├─ payment_typestring []非必须支付方式

item 类型: string

├─ 非必须
├─ send_typestring []非必须发货方式

item 类型: string

├─ 非必须
├─ is_smsnumber非必须开启短信提醒0关闭1开启
├─ is_mailnumber非必须开启邮件提醒0关闭1开启
├─ is_printnumber非必须开启打印0关闭1开启

领取奖品

基本信息

Path: /plugin/scratch/api/scratch/receive

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 奖品记录id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须详见首页
├─ listobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ scratch_idnumber非必须
├─ user_idnumber非必须
├─ statusnumber非必须
├─ typenumber非必须
├─ numnumber非必须
├─ detailstring非必须
├─ pricestring非必须
├─ order_idnumber非必须
├─ goods_idnumber非必须
├─ raffled_atstring非必须
├─ created_atstring非必须
├─ is_deletenumber非必须
├─ deleted_atstring非必须
├─ scratch_activity_idnumber非必须
├─ namestring非必须
├─ settingobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ titlestring非必须
├─ typenumber非必须
├─ probabilitynumber非必须
├─ opptynumber非必须
├─ start_atstring非必须
├─ end_atstring非必须
├─ deplete_integral_numnumber非必须
├─ rulestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ payment_typestring []非必须

item 类型: string

├─ 非必须
├─ send_typestring []非必须

item 类型: string

├─ 非必须
├─ is_smsnumber非必须
├─ is_mailnumber非必须
├─ is_printnumber非必须
├─ opptynumber非必须

首页

基本信息

Path: /plugin/scratch/api/scratch/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须商城id
├─ scratch_idnumber非必须奖品id
├─ user_idnumber非必须用户id
├─ statusnumber非必须0预领取 1 未领取 2 已领取
├─ typenumber非必须1.红包2.优惠卷3.积分4.实物5无
├─ numnumber非必须积分数量
├─ detailstring非必须优惠券信息
├─ pricestring非必须价格
├─ order_idnumber非必须订单id
├─ goods_idnumber非必须商品id
├─ raffled_atstring非必须
├─ created_atstring非必须
├─ is_deletenumber非必须
├─ deleted_atstring非必须
├─ scratch_activity_idnumber非必须活动id
├─ namestring非必须
├─ activityobject非必须活动
├─ idnumber非必须
├─ mall_idnumber非必须商城id
├─ statusnumber非必须状态 0关闭 1开启
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ titlestring非必须活动名称
├─ start_atstring非必须开始时间
├─ end_atstring非必须结束时间
├─ deplete_integral_numnumber非必须消耗积分
├─ scratch_typenumber非必须1天 2用户 默认为2
├─ opptynumber非必须抽奖次数
├─ hint_textstring非必须未中奖提示语
├─ opptynumber非必须

幸运抽奖--插件

商品详情

基本信息

Path: /plugin/lottery/api/lottery/goods

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ goodsobject非必须商品信息
├─ attr_idstring非必须规格id
├─ attr_listobject []非必须规格列表

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ pic_urlobject []非必须轮播图

item 类型: object

├─ idstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须商品链接
├─ namestring非必须名称
├─ numstring非必须数量
├─ original_pricestring非必须原价
├─ detailstring非必须详情
├─ idstring非必须
├─ lotteryobject非必须奖品信息
├─ idstring非必须
├─ mall_idstring非必须
├─ goods_idstring非必须
├─ buy_goods_idstring非必须原商品id
├─ statusstring非必须0关闭 1开启
├─ typestring非必须0未完成 1已完成 2超限 3过期
├─ stockstring非必须库存
├─ start_atstring非必须开始时间
├─ end_atstring非必须结束时间
├─ join_min_numstring非必须参加最少人数限制
├─ sortstring非必须排序
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ participantstring非必须参与人
├─ inviteestring非必须被邀请人
├─ code_numstring非必须抽奖券码数量
├─ titlestring非必须活动标题
├─ goodsobject非必须商品信息
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitstring非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attrobject []非必须

item 类型: object

├─ idstring必须
├─ goods_idstring必须
├─ sign_idstring必须
├─ stockstring必须
├─ pricestring必须
├─ nostring必须
├─ weightstring必须
├─ pic_urlstring必须
├─ is_deletestring必须
├─ lucky_listobject []非必须中奖列表

item 类型: object

├─ lucky_numstring必须幸运码
├─ user_idstring必须
├─ child_idstring必须被邀请人id
├─ statusstring必须0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ lucky_codestring必须幸运码
├─ created_atstring必须
├─ lottery_idstring必须
├─ userobject必须中奖人信息
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须名称
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ user_logobject非必须用户记录
├─ idnumber非必须
├─ mall_idnumber非必须
├─ user_idnumber非必须
├─ lottery_idnumber非必须
├─ statusnumber非必须0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_idnumber非必须商品id
├─ child_idnumber非必须被邀请人id
├─ lucky_codestring非必须幸运码
├─ raffled_atstring非必须
├─ obtain_atstring非必须
├─ created_atstring非必须

奖品记录

基本信息

Path: /plugin/lottery/api/lottery/prize

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 1 1进行中 2中奖 3未中奖
page 是 1 页码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ lottery_idstring必须奖品id
├─ statusstring必须0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_idstring必须
├─ child_idstring必须
├─ lucky_codestring必须幸运码
├─ raffled_atstring必须
├─ obtain_atstring必须
├─ created_atstring必须
├─ lotteryobject必须抽奖信息
├─ idstring非必须
├─ mall_idstring非必须
├─ goods_idstring非必须
├─ buy_goods_idstring非必须原商品id
├─ statusstring非必须0关闭 1开启
├─ typestring非必须0未完成 1已完成 2超限 3过期
├─ stockstring非必须库存
├─ start_atstring非必须开始时间
├─ end_atstring非必须结束时间
├─ join_min_numstring非必须参加最少人数限制
├─ sortstring非必须排序
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ participantstring非必须参与人
├─ inviteestring非必须被邀请人
├─ code_numstring非必须抽奖券码数量
├─ titlestring非必须活动标题
├─ goodsobject必须商品信息
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull,string非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须商品名称
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attrobject []非必须

item 类型: object

├─ idstring必须
├─ goods_idstring必须
├─ sign_idstring必须
├─ stockstring必须
├─ pricestring必须
├─ nostring必须
├─ weightstring必须
├─ pic_urlstring必须
├─ is_deletestring必须
├─ timestring必须开奖时间

奖品详情

基本信息

Path: /plugin/lottery/api/lottery/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
lottery_id 是 1 奖品id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须抽奖信息
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ lottery_idstring非必须
├─ statusstring非必须0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_idstring非必须
├─ child_idstring非必须被邀请id
├─ lucky_codestring非必须幸运码
├─ raffled_atstring非必须
├─ obtain_atstring非必须
├─ created_atstring非必须
├─ parent_numnumber非必须邀请好友数
├─ goodsobject非必须商品信息
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitstring非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须商品名称
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attrobject []非必须

item 类型: object

├─ idstring必须
├─ goods_idstring必须
├─ sign_idstring必须
├─ stockstring必须
├─ pricestring必须
├─ nostring必须
├─ weightstring必须
├─ pic_urlstring必须
├─ is_deletestring必须
├─ attr_idstring非必须
├─ lotteryobject非必须奖品信息 详见首页
├─ idstring非必须
├─ mall_idstring非必须
├─ goods_idstring非必须
├─ buy_goods_idstring非必须
├─ statusstring非必须
├─ typestring非必须
├─ stockstring非必须
├─ start_atstring非必须
├─ end_atstring非必须
├─ join_min_numstring非必须
├─ sortstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ participantstring非必须
├─ inviteestring非必须
├─ code_numstring非必须
├─ titlestring非必须
├─ attrobject非必须规格信息
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ timestring非必须开奖时间
├─ numstring非必须参与数
├─ user_listobject []非必须参与列表

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ lottery_idstring必须
├─ statusstring必须0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_idstring必须
├─ child_idstring必须
├─ lucky_codestring必须幸运码
├─ raffled_atstring必须
├─ obtain_atstring必须
├─ created_atstring必须
├─ userobject必须用户信息
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须用户头像
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须

幸运码

基本信息

Path: /plugin/lottery/api/lottery/code

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页码
lottery_id 是 1 抽奖记录id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ ownobject非必须本人幸运码信息
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ lottery_idstring非必须抽奖id
├─ statusstring非必须0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_idstring非必须
├─ child_idstring非必须被邀请人id
├─ lucky_codestring非必须幸运码
├─ raffled_atstring非必须
├─ obtain_atstring非必须
├─ created_atstring非必须
├─ userobject非必须用户信息
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须用户名称
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ parentstring []非必须邀请人列表

item 类型: string

├─ 非必须
├─ awardstring []非必须中奖记录

item 类型: string

├─ 非必须
├─ numnumber非必须持有数量

海报

基本信息

Path: /plugin/lottery/api/lottery/poster

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pic_urlstring非必须图片

订单提交

基本信息

Path: /plugin/lottery/api/lottery/order-submit

Method: GET

接口描述:
undefined

请求参数

订单预览

基本信息

Path: /plugin/lottery/api/lottery/order-preview

Method: GET

接口描述:
undefined

请求参数

邀请机会

基本信息

Path: /plugin/lottery/api/lottery/clerk

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
user_id text 是 邀请人id
lottery_id text 是 1 奖品id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

配置

基本信息

Path: /plugin/lottery/api/lottery/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ settingobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ typenumber非必须0:分享即送 1: 被分享人参与抽奖
├─ titlestring非必须小程序标题
├─ rulestring非必须规则
├─ created_atstring非必须
├─ payment_typestring []非必须支付方式

item 类型: string

├─ 非必须
├─ send_typestring []非必须发货方式

item 类型: string

├─ 非必须
├─ goods_posterobject非必须海报自定义信息
├─ bg_picobject非必须
├─ urlstring非必须
├─ picobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ headobject非必须
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ nicknameobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ nickname_shareobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ widthnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ poster_bgobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ poster_bg_twoobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ qr_codeobject非必须
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ typenumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ nameobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ descobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ widthnumber非必须
├─ priceobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ del_linestring非必须
├─ colorstring非必须
├─ textstring非必须
├─ file_typestring非必须
├─ line_urlobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ file_pathstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ is_smsnumber非必须开启短信提醒0关1开
├─ is_mailnumber非必须开启邮件提醒0关 1开
├─ is_printnumber非必须开启打印0关 1开
├─ cs_statusnumber非必须是否开启客服提示 0关 1开
├─ cs_prompt_picstring非必须客服提示图片
├─ cs_wechatstring非必须客服微信号
├─ cs_wechat_qrcodestring非必须客服微信号二维码
├─ cs_wechat_flock_qrcodestring非必须微信群二维码

首页

基本信息

Path: /plugin/lottery/api/lottery/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ banner_listobject []非必须轮播图数据

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ pic_urlstring必须轮播图图片
├─ titlestring必须轮播图名称
├─ page_urlstring必须跳转url
├─ open_typestring必须跳转类型
├─ paramsstring必须跳转参数
├─ is_deletestring必须
├─ created_atstring必须
├─ deleted_atstring必须
├─ updated_atstring必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ stockstring非必须库存
├─ end_atstring非必须结束时间
├─ statusnumber非必须0关闭 1开启
├─ lottery_log_countstring非必须参与数
├─ cover_picstring非必须封面图
├─ goods_namestring非必须商品名
├─ pricestring非必须原价

预约--插件

预约商品列表

基本信息

Path: /booking/api/goods/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1
cat_id 否 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须
├─ cover_picstring必须
├─ idnumber必须
├─ goods_idnumber必须
├─ pricestring必须
├─ price_strstring必须价格

预约商品详情

基本信息

Path: /booking/api/goods/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
goods_id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须可补充
├─ listobject非必须
├─ attr_groupobject []非必须

item 类型: object

├─ attr_group_idnumber非必须
├─ attr_group_namestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ attrobject []非必须

item 类型: object

├─ idnumber非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stocknumber非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ is_deletenumber非必须
├─ extrastring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ member_price_2number非必须
├─ price_membernumber非必须
├─ member_price_3number非必须
├─ member_price_4number非必须
├─ member_price_5number非必须
├─ member_price_6number非必须
├─ member_price_7number非必须
├─ member_price_8number非必须
├─ member_price_9number非必须
├─ member_price_10number非必须
├─ member_price_11number非必须
├─ member_price_12number非必须
├─ member_price_13number非必须
├─ member_price_14number非必须
├─ namestring非必须
├─ pic_urlobject []非必须

item 类型: object

├─ idstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ pricestring非必须
├─ detailstring非必须
├─ goods_idnumber非必须
├─ storestring []非必须

item 类型: string

├─ 非必须
├─ idnumber非必须

订单预览

基本信息

Path: /booking/api/order/order-preview

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息

订单提交

基本信息

Path: /booking/api/order/order-submit

Method: GET

接口描述:

请求参数

分类列表

基本信息

Path: /booking/api/booking/cats

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ catobject []非必须详见cats

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ parent_idstring非必须
├─ namestring非必须
├─ pic_urlstring非必须
├─ sortstring非必须
├─ big_pic_urlstring非必须
├─ advert_picstring非必须
├─ advert_urlstring非必须
├─ statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须

门店列表

基本信息

Path: /booking/api/booking/store-list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
goods_id 是 商品id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ storeobject []非必须门店信息

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ store_idstring非必须
├─ goods_idstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ storeobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ longitudestring非必须
├─ latitudestring非必须
├─ scorestring非必须
├─ cover_urlstring非必须
├─ pic_urlstring非必须
├─ business_hoursstring非必须
├─ descriptionstring非必须
├─ is_defaultstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须

配置详情

基本信息

Path: /plugin/booking/api/booking/setting

Method: GET

接口描述:
undefined

请求参数

预约订单列表

基本信息

Path: /plugin/booking/api/order-list/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1
status 是 0 0全部 1待付款 2待使用 4待评价 5售后

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ mch_idstring必须
├─ order_nostring必须
├─ total_pricestring必须
├─ total_pay_pricestring必须
├─ express_original_pricestring必须
├─ express_pricestring必须
├─ total_goods_pricestring必须
├─ total_goods_original_pricestring必须
├─ member_discount_pricestring必须
├─ use_user_coupon_idstring必须
├─ coupon_discount_pricestring必须
├─ use_integral_numstring必须
├─ integral_deduction_pricestring必须
├─ namestring必须
├─ mobilestring必须
├─ addressstring必须
├─ remarkstring必须
├─ order_formobject必须
├─ wordsstring必须
├─ seller_remarkstring必须
├─ is_paystring必须
├─ pay_typestring必须
├─ pay_timestring必须
├─ is_sendstring必须
├─ send_timestring必须
├─ expressstring必须
├─ express_nostring必须
├─ is_salestring必须
├─ is_confirmstring必须
├─ confirm_timestring必须
├─ cancel_statusstring必须
├─ cancel_timestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_recyclestring必须
├─ is_offlinestring必须
├─ offline_qrcodestring必须
├─ clerk_idstring必须
├─ store_idstring必须
├─ signstring必须
├─ tokenstring必须
├─ support_pay_typesstring,null必须
├─ detailobject []必须

item 类型: object

├─ idstring必须
├─ order_idstring必须
├─ goods_idstring必须
├─ numstring必须
├─ unit_pricestring必须
├─ total_original_pricestring必须
├─ total_pricestring必须
├─ member_discount_pricestring必须
├─ goods_infoobject必须
├─ namestring非必须
├─ numstring非必须
├─ total_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ pic_urlstring非必须
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须

预约订单详情

基本信息

Path: /plugin/booking/api/order-list/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 127 订单id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ mch_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ express_original_pricestring非必须
├─ express_pricestring非必须
├─ total_goods_pricestring非必须
├─ total_goods_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ use_user_coupon_idstring非必须
├─ coupon_discount_pricestring非必须
├─ use_integral_numstring非必须
├─ integral_deduction_pricestring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ remarkstring非必须
├─ order_formstring非必须
├─ wordsstring非必须
├─ seller_remarkstring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_sendstring非必须
├─ send_timestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ is_salestring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ cancel_statusstring非必须
├─ cancel_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_recyclestring非必须
├─ is_offlinestring非必须
├─ offline_qrcodestring非必须
├─ clerk_idstring非必须
├─ store_idstring非必须
├─ signstring非必须
├─ tokenstring非必须
├─ support_pay_typesstring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infoobject非必须
├─ namestring非必须
├─ numstring非必须
├─ total_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_negotiablestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ sortstring非必须
├─ mch_sortstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ extrastring非必须
├─ is_default_servicesstring非必须
├─ refundnull非必须
├─ status_textstring非必须
├─ pay_type_textstring非必须
├─ goods_numnumber非必须

预约核销码

基本信息

Path: /plugin/booking/api/order-list/clerk-code

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是

返回数据

名称类型是否必须默认值备注其他信息

预约申请取消

基本信息

Path: /plugin/booking/api/order-list/clerk-code_1557046652082

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 订单id

返回数据

名称类型是否必须默认值备注其他信息

拼团--插件

我的拼团列表

基本信息

Path: /plugin/pintuan/api/order/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pintuan_status 是 0 0.全部

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ end_date_timestring必须拼团剩余时间
├─ detailobject []必须拼团商品详情

item 类型: object

├─ goods_infoobject必须订单商品信息
├─ attr_listobject []非必须商品规格

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ namestring非必须商品名称
├─ cover_picstring非必须商品缩略图
├─ numnumber必须购买数量
├─ total_pricestring必须支付金额
├─ idnumber必须订单ID
├─ pintuan_order_idstring必须拼团订单ID
├─ statusnumber必须拼团状态0.待付款|1.拼团中|2.拼团成功|3.拼团失败|4.未退款
├─ status_cnstring必须拼团状态
├─ total_pay_pricestring必须总支付金额
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

拼团下单

基本信息

Path: /plugin/pintuan/api/order/submit

Method: POST

接口描述:

拼团下单流程

1.拼团单独购买下单走商城下单接口

2.拼团购买下单走此接口,参数在原先接口的参数基础上,增加了pintuan_order_id 和 pintuan_group_id
pintuan_order_id 参与其它团时,需传入拼团订单ID
pintuan_group_id 自己新开团时,需传入拼团组ID

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
form_data text 是 {"list":[{"mch_id":0,"pintuan_order_id":0,"pintuan_group_id":219,"goods_list":[{"id":38461,"attr":[{"attr_id":1,"attr_group_id":1}],"num":1,"goods_attr_id":84149,"cart_id":0}],"distance":0,"remark":"","order_form":[],"use_integral":0,"user_coupon_id":0}],"address_id":0} 拼团下单

返回数据

名称类型是否必须默认值备注其他信息

拼团分类列表

基本信息

Path: /plugin/pintuan/api/goods/cats

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须分类ID
├─ namestring必须分类名称

拼团商品列表

基本信息

Path: /plugin/pintuan/api/goods/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cat_id 是 0 分类ID 0

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须商品ID
├─ namestring非必须商品名称
├─ cover_picstring非必须商品缩略图
├─ original_pricestring非必须商品原价
├─ salesnumber非必须商品销量
├─ vip_card_appointobject非必须
├─ discountnull非必须会员折扣
├─ is_my_vip_card_goodsnumber非必须登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_usernumber非必须登录用户是不是会员 1是 0否
├─ pricestring非必须商品价格(最低拼团价)
├─ goods_stocknumber非必须商品总库存
├─ level_pricenumber非必须会员价
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

拼团商品详情

基本信息

Path: /plugin/pintuan/api/goods/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 商品ID
group_id 是 0 0.表示单买

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idstring非必须商品ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ goods_warehouse_idstring非必须关联商品库ID
├─ statusstring非必须上架状态:0=下架,1=上架
├─ pricestring非必须售价
├─ use_attrstring非必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring非必须商品规格组
├─ goods_stockstring非必须商品总库存(规格库存相加)
├─ virtual_salesstring非必须已出售量(虚拟销量)
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模板ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否单独设置会员价
├─ share_typestring非必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring非必须商品标示用于区分商品属于什么模块
├─ app_share_picstring非必须商品自定义分享图片
├─ app_share_titlestring非必须商品自定义分享标题
├─ attrobject []非必须

item 类型: object

├─ idstring必须
├─ goods_idstring必须商品ID
├─ sign_idstring必须规格票房
├─ stockstring必须库存
├─ pricestring必须价格
├─ nostring必须货号
├─ weightstring必须重量
├─ pic_urlstring必须图片
├─ is_deletestring必须
├─ extrastring必须额外字段
├─ shareobject必须
├─ idstring非必须
├─ share_commission_firststring非必须一级合伙人金额
├─ share_commission_secondstring非必须二级
├─ share_commission_thirdstring非必须三级
├─ goods_idstring非必须商品ID
├─ goods_attr_idstring非必须规格ID
├─ is_deletestring非必须
├─ attr_listobject []必须规格组

item 类型: object

├─ attr_group_namestring必须规格组名称
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ member_price_2string必须会员价
├─ price_memberstring必须当前会员价格
├─ member_price_3string必须会员价
├─ member_price_4string必须会员价
├─ member_price_5string必须
├─ member_price_7string必须
├─ member_price_8string必须
├─ member_price_10string必须
├─ member_price_11string必须
├─ member_price_12string必须
├─ member_price_13string必须
├─ member_price_14string必须
├─ sharenumber非必须
├─ cardsstring []非必须卡券

item 类型: string

├─ 非必须
├─ servicesstring []非必须商品服务

item 类型: string

├─ 非必须
├─ pintuanGoodsobject非必须拼团商品信息
├─ idstring非必须
├─ is_alone_buystring非必须是否允许单独购买
├─ mall_idstring非必须
├─ goods_idstring非必须
├─ end_timestring非必须拼团结束时间
├─ groups_restrictionsstring非必须拼团次数限制
├─ buy_num_restrictionsstring非必须购买数量限制
├─ is_deletestring非必须
├─ pintuan_groupsobject []非必须拼团组信息

item 类型: object

├─ idstring非必须
├─ goods_idstring非必须商品ID
├─ people_numstring非必须拼团所需总人数
├─ preferential_pricestring非必须团长优惠
├─ pintuan_timestring非必须拼团限时
├─ goods_numnumber非必须商品库存
├─ goods_nostring非必须商品货号
├─ goods_weightstring非必须商品重量
├─ price_minnumber非必须规格最小价
├─ price_maxnumber非必须规格最大价
├─ salesnumber非必须
├─ advertisementobject []非必须

item 类型: object

├─ pic_urlstring必须
├─ link_urlstring必须

拼团详情

基本信息

Path: /plugin/pintuan/api/order/pintuan-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 拼团组ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须拼团订单ID
├─ statusnumber非必须拼团订单状态0.待付款|1.拼团中|2.拼团成功|3.拼团失败|4.未退款
├─ status_cnstring非必须拼团订单状态
├─ goods_namestring非必须商品名称
├─ goods_cover_picstring非必须商品缩略图
├─ original_pricestring非必须商品原价
├─ people_numnumber非必须拼团所需总人数
├─ is_parentnumber非必须是否为团长0.否|1.是
├─ group_usersobject []非必须拼团用户列表

item 类型: object

├─ idnumber非必须关联ID
├─ nicknamestring非必须用户昵称
├─ avatarstring非必须用户头像
├─ pricenumber非必须拼团价(拼团最低价)
├─ group_economize_pricestring非必须拼团省价
├─ surplus_peoplenumber非必须拼团剩余人数
├─ surplus_date_timestring非必须拼团结束时间

拼团首页

基本信息

Path: /plugin/pintuan/api/index/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ bannersobject []非必须

item 类型: object

├─ idstring必须ID
├─ mall_idstring必须商城ID
├─ pic_urlstring必须图片
├─ titlestring必须标题
├─ page_urlstring必须小程序页面路径
├─ open_typestring必须打开方式:redirect 重定向跳转|navigate普通跳转|app 跳转小程序|contact 客服| clear_cache 清除缓存| tel 拔打电话|web 跳转网页
├─ paramsstring必须导航参数
├─ is_deletestring必须
├─ created_atstring必须
├─ deleted_atstring必须
├─ updated_atstring必须
├─ settingobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须商城ID
├─ is_sharenumber非必须是否开启合伙人 0.否|1.是
├─ is_smsnumber非必须是否短信提醒0.否|1.是
├─ is_mailnumber非必须是否开启邮件通知0.否|1.是
├─ is_printnumber非必须是否开启订单打印0.否|1.是
├─ rulesobject []非必须拼团规则

item 类型: object

├─ titlestring非必须规则标题
├─ contentstring非必须规则内容
├─ is_territorial_limitationnumber非必须是否开启区域允许购买
├─ advertisementobject非必须拼团广告
├─ current_style_idstring非必须广告样式ID
├─ typestring非必须
├─ listobject []非必须广告样式参数

item 类型: object

├─ pic_urlstring非必须
├─ link_urlstring非必须
├─ stylestring非必须
├─ widthstring非必须
├─ heightstring非必须
├─ topstring非必须
├─ leftstring非必须
├─ open_typestring非必须
├─ is_advertisementnumber非必须是否开启拼团广告0.否|1.是
├─ created_atstring非必须
├─ payment_typestring []非必须支付方式

item 类型: string

├─ 非必须
├─ send_typestring []非必须发货方式

item 类型: string

├─ 非必须
├─ goods_posterobject非必须拼团海报
├─ bg_picobject非必须背景图
├─ urlstring非必须
├─ picobject非必须商品图
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ headobject非必须商品名称
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ nicknameobject非必须用户昵称
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ nickname_shareobject非必须合伙人昵称
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ poster_bgobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ qr_codeobject非必须二维码
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ typenumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ nameobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ descobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ widthnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ priceobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ textstring非必须
├─ file_typestring非必须

秒杀--插件

秒杀商品分类列表(未使用)

基本信息

Path: /plugin/miaosha/api/goods/cats

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ parent_idstring必须
├─ namestring必须分类名称
├─ pic_urlstring必须分类图标
├─ sortstring必须排序
├─ big_pic_urlstring必须
├─ advert_picstring必须
├─ advert_urlstring必须
├─ statusstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

今日秒杀(未使用)

基本信息

Path: /miaosha/api/goods/today-miaosha

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cat_id 是 0 0.全部

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listarray []非必须

item 类型: array

├─ 非必须
├─ 非必须
├─ surplus_d_timenumber非必须当天剩余秒数
├─ surplus_h_timenumber非必须当前整点剩余秒数

商品详情

基本信息

Path: /plugin/miaosha/api/goods/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 秒杀商品ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idstring非必须商品ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ goods_warehouse_idstring非必须关联商品库ID
├─ statusstring非必须上架状态:0=下架,1=上架
├─ pricestring非必须售价
├─ use_attrstring非必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring非必须商品规格组
├─ goods_stockstring非必须商品总库存(规格库存相加)
├─ virtual_salesstring非必须已出售量(虚拟销量)
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模板ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否单独设置会员价
├─ share_typestring非必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring非必须商品标示用于区分商品属于什么模块
├─ app_share_picstring非必须商品自定义分享图片
├─ app_share_titlestring非必须商品自定义分享标题
├─ is_default_servicesstring非必须默认服务 0.否|1.是
├─ sortstring非必须商品排序
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须统计 支付人数
├─ payment_numstring非必须统计 支付件数
├─ payment_amountstring非必须统计 支付金额
├─ payment_orderstring非必须支付订单数
├─ confine_order_countstring非必须限制下单数量
├─ is_area_limitstring非必须是否单独区域购买
├─ area_limitstring非必须区域限制详情 json格式
├─ share_level_typestring非必须合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_idstring非必须自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ cover_picstring非必须商品缩略图
├─ unitstring非必须商品单位
├─ detailstring非必须商品详情
├─ video_urlstring非必须商品视频
├─ level_shownumber非必须会员等级是否显示0.否|1.是
├─ is_salesnumber非必须是否售后
├─ attrobject []非必须商品规格

item 类型: object

├─ idnumber必须规格ID
├─ goods_idnumber必须商品ID
├─ sign_idstring必须规格组合,关联规格组
├─ stocknumber必须库存
├─ pricestring必须规格价
├─ nostring必须商品货号
├─ weightnumber必须商品重量
├─ pic_urlstring必须商品轮播图
├─ is_deletenumber必须
├─ attr_listobject []必须规格组信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ price_membernumber必须会员价
├─ member_price_listobject []必须

item 类型: object

├─ idnumber必须
├─ levelnumber必须
├─ pricestring必须
├─ goods_attr_idnumber必须
├─ is_deletenumber必须
├─ goods_idnumber必须
├─ member_price_2number必须
├─ member_price_3number必须
├─ goods_numnumber非必须商品库存
├─ goods_nostring非必须商品货号
├─ goods_weightnumber非必须商品重量
├─ servicesstring []非必须商品服务

item 类型: string

├─ 非必须
├─ cardsstring []非必须商品卡券

item 类型: string

├─ 非必须
├─ price_minnumber非必须规格最小价
├─ price_maxnumber非必须规格最大价
├─ pic_urlobject []非必须商品轮播图

item 类型: object

├─ idstring必须
├─ pic_urlstring必须
├─ sharenumber非必须
├─ salesnumber非必须
├─ favoriteboolean非必须
├─ goods_marketingobject非必须
├─ limitstring非必须
├─ pickupstring非必须
├─ shippingstring非必须
├─ goods_marketing_awardobject非必须
├─ cardobject非必须
├─ titlestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ integralobject非必须
├─ titlestring非必须
├─ vip_card_appointobject非必须
├─ discountnull非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ price_member_maxnumber非必须
├─ price_member_minnumber非必须
├─ miaoshaGoodsobject非必须
├─ idnumber非必须ID
├─ mall_idnumber非必须商城ID
├─ goods_idnumber非必须商品ID
├─ goods_warehouse_idnumber非必须商品库ID
├─ open_timenumber非必须开放时间
├─ open_datestring非必须开放日期
├─ buy_limitnumber非必须限单 -1|不限单
├─ virtual_miaosha_numnumber非必须虚拟秒杀量
├─ is_deletestring非必须
├─ miaosha_statusnumber非必须秒杀状态:0.已结束|1.正在进行中|2.未开始
├─ miaosha_timenumber非必须秒杀剩余时间(单位:秒)
├─ miaosha_buy_countnumber非必须已被抢购总数(包含虚拟销量)

整点秒杀商品列表

基本信息

Path: /plugin/miaosha/api/goods/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
open_date 是 2019-04-05 秒杀日期
open_time 是 1 秒杀时间
type 是 1 1.整点商品2.秒杀预告商品

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须ID
├─ mall_idnumber非必须商城ID
├─ goods_idnumber非必须商品ID
├─ goods_warehouse_idnumber非必须商品库ID
├─ open_timenumber非必须开放时间
├─ open_datestring非必须开放日期
├─ buy_limitnumber非必须限单 -1|不限单
├─ virtual_miaosha_numnumber非必须虚拟秒杀量
├─ is_deletenumber非必须
├─ min_pricestring非必须商品规格最小价
├─ miaosha_countnumber非必须已秒杀数量
├─ miaosha_numnumber非必须当前秒杀商品库存
├─ miaosha_percentagestring非必须已秒杀百分比
├─ is_levelnumber非必须是否显示会员价
├─ level_pricenumber非必须会员价格
├─ goodsobject非必须
├─ idnumber非必须ID
├─ mall_idnumber非必须商城ID
├─ goods_idnumber非必须商品ID
├─ goods_warehouse_idnumber非必须商品库ID
├─ open_timenumber非必须开放时间
├─ open_datestring非必须开放日期
├─ buy_limitnumber非必须限单 -1|不限单
├─ virtual_miaosha_numnumber非必须虚拟秒杀量
├─ is_deletenumber非必须
├─ min_pricestring非必须商品规格最小价
├─ miaosha_countnumber非必须已秒杀数量
├─ miaosha_numnumber非必须当前秒杀商品库存
├─ miaosha_percentagestring非必须已秒杀百分比
├─ is_levelnumber非必须是否显示会员价
├─ level_pricenumber非必须会员价格
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ cost_pricestring非必须成本价
├─ detailstring非必须商品详情
├─ cover_picstring非必须商品缩略图
├─ pic_urlstring非必须商品轮播衅
├─ video_urlstring非必须商品视频
├─ unitstring非必须商品单位
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ vip_card_appointobject非必须超级会员卡优惠
├─ discountnull非必须优惠折扣
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

正在进行|即将开始 秒杀列表(未使用)

基本信息

Path: /miaosha/api/goods/miaosha

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 1 1.正在秒杀(默认) 2.即将开始
cat_id 是 0 0.全部

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ goods_idstring非必须商城商品ID
├─ open_timestring非必须开始时间
├─ open_datestring非必须开始日期
├─ buy_limitstring非必须限单 -1|不限单
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模版ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否享受会员价购买
├─ share_typestring非必须佣金配比 0--固定金额 1--百分比
├─ app_share_picstring非必须自定义分享图片
├─ app_share_titlestring非必须自定义分享标题
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ goodsobject非必须商城商品信息
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_negotiablestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ sortstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ extranull非必须
├─ is_default_servicesstring非必须
├─ attrobject []非必须秒杀商品规格

item 类型: object

├─ idstring必须
├─ goods_attr_idstring必须商城商品规格ID
├─ miaosha_pricestring必须秒杀价
├─ miaosha_stockstring必须秒杀库存
├─ miaosha_goods_idstring必须秒杀商品ID
├─ min_pricestring非必须显示最小价
├─ miaosha_countnumber非必须已秒杀数量
├─ miaosha_numnumber非必须秒杀总数
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

加入购物车

基本信息

Path: /miaosha/api/index/add-cart

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
miaosha_goods_id text 是 149 秒杀商品ID
attr_id text 是 1 秒杀规格ID
num text 是 1 数量

返回数据

名称类型是否必须默认值备注其他信息

秒杀整点时间段列表

基本信息

Path: /miaosha/api/goods/time-list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ open_timestring必须整点开始时间
├─ new_open_timestring必须整点开始时间(时间格式)
├─ labelstring必须活动状态(中文)
├─ statusnumber必须status
├─ timenumber必须剩余时间(单位:秒)
├─ date_timestring必须整点开始时间
├─ is_estimatenumber非必须是否秒杀商品预告0.否|1.是
├─ next_miaosha_date_timestring非必须下一场秒杀开始日期时间

秒杀订单提交(参数与商城相同)

基本信息

Path: /plugin/miaosha/api/order/submit

Method: GET

接口描述:

请求参数

秒杀订单预览(参数与商城相同)

基本信息

Path: /plugin/miaosha/api/order/order-preview

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息

秒杀首页

基本信息

Path: /plugin/miaosha/api/index/index

Method: GET

接口描述:

跳转方式参数说明

app跳转
    app_id    跳转小程序的appID
    path    跳转的小程序页面

tel 跳转
    tel    联系电话

web 跳转
    url    跳转网页路径

contact 跳转~~~~

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ bannersobject []非必须首页轮播图

item 类型: object

├─ idstring非必须ID
├─ mall_idstring非必须商城ID
├─ pic_urlstring非必须图片
├─ titlestring非必须标题
├─ page_urlstring非必须小程序页面路径
├─ open_typestring非必须打开方式:redirect 重定向跳转|navigate普通跳转|app 跳转小程序|contact 客服| clear_cache 清除缓存| tel 拔打电话|web 跳转网页
├─ paramsstring非必须导航参数
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ updated_atstring非必须
├─ settingobject非必须
├─ idnumber非必须ID
├─ mall_idnumber非必须商城ID
├─ over_timenumber非必须未支付订单取消时间
├─ is_sharenumber非必须是否开启合伙人 0.否|1.是
├─ is_smsnumber非必须是否短信提醒0.否|1.是
├─ is_mailnumber非必须是否开启邮件通知0.否|1.是
├─ is_printnumber非必须是否开启订单打印0.否|1.是
├─ is_territorial_limitationnumber非必须区域购买限制0.否|1.是
├─ open_timestring []非必须秒杀开放时间

item 类型: string

├─ 非必须
├─ created_atstring非必须
├─ payment_typestring []非必须支付方式

item 类型: string

├─ 非必须
├─ send_typestring []非必须

item 类型: string

├─ 非必须
├─ goods_posterobject非必须秒杀自定义海报
├─ bg_picobject非必须背景图
├─ urlstring非必须
├─ picobject非必须商品图
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ headobject非必须头像
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ nicknameobject非必须用户昵称
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ nickname_shareobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ poster_bgobject非必须标识
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ poster_timeobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ time_strobject非必须时间
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ qr_codeobject非必须二维码
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ typenumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ nameobject非必须商品名称
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ descobject非必须描述
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ widthnumber非必须
├─ priceobject非必须商品价格
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ textstring非必须
├─ file_typestring非必须

购物车编辑

基本信息

Path: /miaosha/api/index/cart-edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
list text 是 和商城一样

返回数据

名称类型是否必须默认值备注其他信息

DIY装修API

页面详情

基本信息

Path: /plugin/diy/api/page/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 页面id

返回数据

名称类型是否必须默认值备注其他信息

多商户

修改订单总价

基本信息

Path: /plugin/mch/api/order/update-total-price

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
total_price text 是 10 价格
mch_id text 是 1 多商户ID
order_id text 是 1 订单ID
express_price text 是 1 运费

返回数据

名称类型是否必须默认值备注其他信息

资产首页

基本信息

Path: /plugin/mch/api/property/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
mch_id 是 10 多商户ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ account_moneystring非必须可提现余额
├─ transfer_ratenumber非必须手续费
├─ close_moneynumber非必须结算金额
├─ not_close_moneynumber非必须未结算金额

单商品修改价格

基本信息

Path: /plugin/mch/api/order/update-price

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
total_price text 是 10 价格
mch_id text 是 1 多商户ID
order_detail_id text 是 1 订单详情ID

返回数据

名称类型是否必须默认值备注其他信息

售后订单详情

基本信息

Path: /plugin/mch/api/order/refund-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 18 售后订单ID
mch_id 是 10 商户ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须售后订单ID
├─ mall_idnumber非必须商城ID
├─ mch_idnumber非必须商户ID
├─ user_idnumber非必须用户ID
├─ order_idnumber非必须关联订单ID
├─ order_detail_idnumber非必须关联订单详情ID
├─ order_nostring非必须售后订单号
├─ typenumber非必须售后类型:1=退货退款,2=换货
├─ refund_pricestring非必须退款金额
├─ remarkstring非必须用户退款备注、说明
├─ pic_liststring非必须用户上传图片凭证
├─ statusnumber非必须订单状态 1.待商家处理 2.同意 3.拒绝
├─ status_timestring非必须商家处理时间
├─ merchant_remarkstring非必须商家同意|拒绝备注、理由
├─ is_sendnumber非必须用户是否发货 0.未发货1.已发货
├─ send_timestring非必须发货时间
├─ customer_namestring非必须京东商家编号
├─ expressstring非必须快递公司
├─ express_nostring非必须快递单号
├─ address_idnumber非必须退换货地址ID
├─ is_confirmnumber非必须商家是否确认操作0.未确认|1.已确认
├─ confirm_timestring非必须确认时间
├─ is_refundnumber非必须退货退款时,是否退款
├─ refund_timestring非必须退款时间
├─ merchant_customer_namestring非必须换货-商家京东商家编号
├─ merchant_expressstring非必须换货-商家发货快递公司
├─ merchant_express_nostring非必须换货-商家发货快递单号
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ status_textstring非必须售后订单状态(中文)
├─ detailobject []非必须

item 类型: object

├─ idnumber非必须商品详情ID
├─ order_idnumber非必须关联订单ID
├─ goods_idnumber非必须商品ID
├─ numnumber非必须商品数量
├─ unit_pricestring非必须商品单价
├─ total_original_pricestring非必须商品原总价(优惠前)
├─ total_pricestring非必须商品总价(优惠后)
├─ member_discount_pricestring非必须会员优惠金额(正数表示优惠,负数表示加价)
├─ goods_infoobject非必须商品信息josn格式
├─ namestring非必须商品名称
├─ attr_listobject []非必须已选规格信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ pic_urlstring非必须商品缩略图
├─ numnumber非必须商品数量
├─ total_original_pricestring非必须商品总价(优惠前)
├─ member_discount_pricestring非必须会员折扣金额
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_refundnumber非必须商品是否退款
├─ refund_statusnumber非必须售后状态 0--未售后 1--售后中 2--售后结束
├─ back_pricestring非必须售后状态 0--未售后 1--售后中 2--售后结束
├─ signstring非必须订单详情标识,用于区分插件
├─ goods_nostring非必须商品货号
├─ orderobject非必须
├─ namestring非必须收件人
├─ mobilestring非必须收件人电话
├─ addressstring非必须收件人地址
├─ express_listobject []非必须快递公司列表

item 类型: object

├─ idnumber必须
├─ namestring必须
├─ codestring必须
├─ addressstring []非必须完整收件人地址

item 类型: string

├─ 非必须

订单同意|拒绝取消

基本信息

Path: /plugin/mch/api/order/cancel

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 是 10 多商户ID
order_id text 是 1 商品ID
remark text 是 同意
status text 是 1.同意

返回数据

名称类型是否必须默认值备注其他信息

订单发货

基本信息

Path: /api/order/order-send

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 152 订单ID
mch_id text 是 10 多商户ID
express text 是 顺丰速运
express_no text 是 218371209380918
words text 否 备注
is_express text 是 是否快递发货0.否

返回数据

名称类型是否必须默认值备注其他信息

获取面单

基本信息

Path: /plugin/mch/api/order/print

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
order_id 是 1 订单ID
express 是 顺丰速运 快递公司
mch_id 是 1

返回数据

名称类型是否必须默认值备注其他信息

结算记录

基本信息

Path: /plugin/mch/api/property/order-close-log

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
mch_id 是 10
is_transfer 是 0 0.未结算

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mchOrderobject必须
├─ idstring非必须
├─ order_idstring非必须订单ID
├─ is_transferstring非必须是否转入商户0.否|1.是
├─ updated_atstring非必须
├─ detailobject []必须

item 类型: object

├─ idnumber必须商品详情ID
├─ order_idnumber必须关联订单ID
├─ goods_idnumber必须商品ID
├─ numnumber必须商品数量
├─ unit_pricestring必须商品单价
├─ total_original_pricestring必须商品原总价(优惠前)
├─ total_pricestring必须商品总价(优惠后)
├─ member_discount_pricestring必须会员优惠金额(正数表示优惠,负数表示加价)
├─ goods_infoobject必须商品信息josn格式
├─ namestring非必须商品名称
├─ attr_listobject []非必须已选规格信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ pic_urlstring非必须商品缩略图
├─ numnumber非必须商品数量
├─ total_original_pricestring非必须商品总价(优惠前)
├─ member_discount_pricestring非必须会员折扣金额
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ goodsobject必须
├─ idstring非必须商品ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ namestring非必须
├─ pricestring非必须售价
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ goods_warehouse_idstring非必须关联商品库ID
├─ statusstring非必须上架状态:0=下架,1=上架
├─ use_attrstring非必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring非必须商品规格组
├─ goods_stockstring非必须商品总库存(规格库存相加)
├─ virtual_salesstring非必须已出售量(虚拟销量)
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模板ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否单独设置会员价
├─ share_typestring非必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring非必须商品标示用于区分商品属于什么模块
├─ app_share_picstring非必须商品自定义分享图片
├─ app_share_titlestring非必须商品自定义分享标题
├─ extrastring非必须其它插件o数据
├─ is_default_servicesstring非必须是不否为
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

商品申请上架

基本信息

Path: /plugin/mch/api/goods/apply-status

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 是 1 备注
id text 是 1 商品ID

返回数据

名称类型是否必须默认值备注其他信息

收支记录

基本信息

Path: /plugin/mch/api/property/account-log

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
mch_id 是 10

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须商城ID
├─ mch_idstring必须商户ID
├─ moneystring必须金额
├─ descstring必须备注说明
├─ typestring必须类型:1=收入,2=支出
├─ created_atstring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

提现记录

基本信息

Path: /plugin/mch/api/property/cash-log

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
mch_id 是 10

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须提现ID
├─ mall_idstring必须商城ID
├─ mch_idstring必须多商户ID
├─ moneystring必须提现金额
├─ order_nostring必须提现订单号
├─ statusstring必须提现状态:0=待处理,1=同意,2=拒绝
├─ typestring必须wx 微信| alipay 支付宝 | bank 银行卡 | balance 余额
├─ type_datastring必须不同提现类型,提交的数据
├─ virtual_typestring必须后台实际上打款方式
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

商家售后处理

基本信息

Path: /plugin/mch/api/order/refund-handle

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 是 1
order_refund_id text 是 1 售后订单ID
merchant_remark text 是 备注 商家备注
is_agree text 是 1 商家是否同意0.拒绝
address_id text 是 1 退换货地址ID
type text 是 1 售后类型 1退货 2 换货
refund_price text 是 10 退款金额
express text 是 顺丰速运 快递公司
express_no text 是 快递单号
is_express text 是 是否快递发货0.否

返回数据

名称类型是否必须默认值备注其他信息

提现申请

基本信息

Path: /plugin/mch/api/property/cash-submit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 是 1 商户ID
type text 是 wx 提现类型: wx 微信线下转账
type_data text 是 提现类型数据
money text 是 提现金额

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ statusstring非必须是否营业0.否|1.是
├─ is_recommendstring非必须好店推荐:0.不推荐|1.推荐
├─ review_statusstring非必须审核状态:0=待审核,1.审核通过.2=审核不通过
├─ review_remarkstring非必须审核结果、备注
├─ review_timestring非必须审核时间
├─ realnamestring非必须真实姓名
├─ wechatstring非必须真实姓名
├─ mobilestring非必须手机号码
├─ mch_common_cat_idstring非必须
├─ transfer_ratestring非必须商户手续费
├─ account_moneystring非必须账户余额
├─ sortstring非必须店铺排序|升序
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ store_idstring非必须
├─ platformstring非必须
├─ storeobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ longitudestring非必须
├─ latitudestring非必须
├─ scorestring非必须
├─ cover_urlstring非必须
├─ pic_urlstring非必须
├─ business_hoursstring非必须
├─ descriptionstring非必须
├─ scopestring非必须
├─ is_defaultstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

快递公司列表

基本信息

Path: /api/express/express-list

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须ID
├─ namestring必须物流公司名称
├─ codestring必须物流编码

多商户入驻申请

基本信息

Path: /plugin/mch/api/mch/apply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 多商户ID
realname text 是 wxf 真实姓名
wechat text 是 wechat 微信号
mobile text 是 手机号 手机号
address text 是 浙江省嘉兴市 地址
mch_common_cat_id text 是 1 多商户类目ID1
name text 是 wxf 店铺名称
logo text 是 店铺头像
bg_pic_url text 是 [] 背景图(数组对象格式)
service_mobile text 是 123456 客服电话
province_id text 是 1 省ID
city_id text 是 1 市ID
district_id text 是 1 区ID
username text 是 商户账号
password text 是 商户密码
form_data text 是 自定义表单
is_update_apply text 是 1 重新提交审核时使用

返回数据

名称类型是否必须默认值备注其他信息

多商户列表

基本信息

Path: /plugin/mch/api/mch/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页
keyword 否 小二 店铺名称
mch_common_cat_id 否 1 类目ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须店铺ID
├─ mall_idstring非必须商城ID
├─ user_idstring非必须用户ID
├─ statusstring非必须是否营业0.否|1.是
├─ is_recommendstring非必须好店推荐:0.不推荐|1.推荐
├─ review_statusstring非必须审核状态:0=待审核,1.审核通过.2=审核不通过
├─ review_remarkstring非必须审核结果、备注
├─ review_timestring非必须审核时间
├─ realnamestring非必须真实姓名
├─ wechatstring非必须真实姓名
├─ mobilestring非必须手机号码
├─ mch_common_cat_idstring非必须商户所属类目ID
├─ transfer_ratestring非必须商户手续费
├─ account_moneystring非必须账户余额
├─ sortstring非必须店铺排序|升序
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userobject非必须
├─ idstring非必须用户ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ usernamestring非必须用户名
├─ passwordstring非必须密码
├─ nicknamestring非必须用户昵称
├─ auth_keystring非必须授权key
├─ access_tokenstring非必须token
├─ mobilestring非必须手机号
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须用户ID
├─ avatarstring非必须头像
├─ platform_user_idstring非必须用户所属平台的用户id
├─ integralstring非必须剩余积分
├─ total_integralstring非必须最高积分
├─ balancestring非必须余额
├─ total_balancestring非必须总余额
├─ parent_idstring非必须上级id
├─ is_blackliststring非必须是否黑名单
├─ contact_waystring非必须联系方式
├─ remarkstring非必须备注
├─ is_deletestring非必须
├─ junior_atstring非必须成为下级时间
├─ platformstring非必须用户所属平台标识
├─ temp_parent_idstring非必须临时上级
├─ storeobject非必须商户店铺信息
├─ idstring非必须店铺ID
├─ mall_idstring非必须商城Id
├─ mch_idstring非必须商户ID
├─ namestring非必须店铺名称
├─ mobilestring非必须联系方式
├─ addressstring非必须店铺地址
├─ longitudestring非必须店铺经度
├─ latitudestring非必须店铺纬度
├─ scorestring非必须店铺评分
├─ cover_urlstring非必须店铺封面图
├─ pic_urlstring非必须门店轮播图
├─ business_hoursstring非必须营业时间
├─ descriptionstring非必须门店描述
├─ is_defaultstring非必须默认总店0.否|1.是
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

多商户更新密码

基本信息

Path: /plugin/mch/api/mch/update-password

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 是 1 多商户ID
password text 是 新密码

返回数据

名称类型是否必须默认值备注其他信息

多商户状态

基本信息

Path: /plugin/mch/api/mch/mch-status

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ mchobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须商城ID
├─ user_idnumber非必须用户ID
├─ statusnumber非必须是否营业0.否|1.是
├─ is_recommendnumber非必须好店推荐:0.不推荐|1.推荐
├─ review_statusnumber非必须审核状态:0=待审核,1.审核通过.2=审核不通过
├─ review_remarkstring非必须审核结果、备注
├─ review_timestring非必须审核时间
├─ realnamestring非必须真实姓名
├─ wechatstring非必须微信号
├─ mobilestring非必须手机号码
├─ mch_common_cat_idnumber非必须商户所属类目
├─ transfer_ratenumber非必须商户手续费
├─ account_moneystring非必须账户余额
├─ sortnumber非必须店铺排序|升序
├─ form_datastring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ tokenstring非必须

店铺统计年份列表

基本信息

Path: /plugin/mch/api/mch/year-list

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ year_listobject []非必须年份列表

item 类型: object

├─ yearnumber必须年
├─ month_listobject []必须

item 类型: object

├─ monthnumber必须月
├─ name_enstring必须月份(英文)
├─ name_cnstring必须月份(中文)
├─ activeboolean必须是否选中
├─ activeboolean必须是否选中
├─ current_yearnumber非必须当前年份
├─ current_monthnumber非必须当前月份

多商户账号密码登录

基本信息

Path: /plugin/mch/api/mch/login

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
username text 是 用户名
password text 是 密码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ mchobject非必须商户信息
├─ idnumber非必须
├─ mall_idnumber非必须商城ID
├─ user_idnumber非必须用户ID
├─ statusnumber非必须是否营业0.否|1.是
├─ is_recommendnumber非必须好店推荐:0.不推荐|1.推荐
├─ review_statusnumber非必须审核状态:0=待审核,1.审核通过.2=审核不通过
├─ review_remarkstring非必须审核结果、备注
├─ review_timestring非必须审核时间
├─ realnamestring非必须真实姓名
├─ wechatstring非必须微信号
├─ mobilestring非必须手机号码
├─ mch_common_cat_idnumber非必须商户所属类目
├─ transfer_ratenumber非必须商户手续费
├─ account_moneystring非必须账户余额
├─ sortnumber非必须店铺排序|升序
├─ form_datastring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ tokenstring非必须商户登录token 商户接口需要在header中传入

多商户详情

基本信息

Path: /plugin/mch/api/mch/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 10 多商户ID
review_status 是 1 0.可查看未通过审核的商户信息

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须商城ID
├─ user_idnumber非必须用户ID
├─ statusnumber非必须是否营业0.否|1.是
├─ is_recommendnumber非必须好店推荐:0.不推荐|1.推荐
├─ review_statusnumber非必须审核状态:0=待审核,1.审核通过.2=审核不通过
├─ review_remarkstring非必须审核结果、备注
├─ review_timestring非必须审核时间
├─ realnamestring非必须真实姓名
├─ wechatstring非必须微信号
├─ mobilestring非必须手机号码
├─ mch_common_cat_idnumber非必须商户所属类目
├─ transfer_ratenumber非必须商户手续费
├─ account_moneystring非必须账户余额
├─ sortnumber非必须店铺排序|升序
├─ form_datastring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ userobject非必须
├─ idstring非必须用户ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ usernamestring非必须用户名
├─ passwordstring非必须密码
├─ nicknamestring非必须用户昵称
├─ auth_keystring非必须授权key
├─ access_tokenstring非必须token
├─ mobilestring非必须手机号
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须用户ID
├─ avatarstring非必须头像
├─ platform_user_idstring非必须用户所属平台的用户id
├─ integralstring非必须剩余积分
├─ total_integralstring非必须最高积分
├─ balancestring非必须余额
├─ total_balancestring非必须总余额
├─ parent_idstring非必须上级id
├─ is_blackliststring非必须是否黑名单
├─ contact_waystring非必须联系方式
├─ remarkstring非必须备注
├─ is_deletestring非必须
├─ junior_atstring非必须成为下级时间
├─ platformstring非必须用户所属平台标识
├─ temp_parent_idstring非必须临时上级
├─ mchUserobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ storeobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ longitudestring非必须
├─ latitudestring非必须
├─ scorestring非必须
├─ cover_urlstring非必须
├─ pic_urlstring非必须
├─ business_hoursstring非必须
├─ descriptionstring非必须
├─ scopestring非必须
├─ is_defaultstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ categoryobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ sortstring非必须
├─ statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须

多商户类目列表

基本信息

Path: /plugin/mch/api/mch/category

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须类目ID
├─ mall_idstring必须商城ID
├─ namestring必须类目名称
├─ sortstring必须排序
├─ statusstring必须是否显示
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

商品列表

基本信息

Path: /plugin/mch/api/goods/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页
mch_id 是 10 多商户ID
sort 是 1 1.全部商品
sort_type 否 1 1.价格排序,升序
status 否 0.下架商品
keyword 否 搜索
is_sold_out 是 售罄商品 0.否

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须商品ID
├─ goods_warehouse_idnumber必须商品库ID
├─ mch_idnumber必须商户ID
├─ signstring必须插件商品标识
├─ namestring必须商品名称
├─ cover_picstring必须商品缩略图
├─ original_pricestring必须商品原价
├─ unitstring必须商品单位
├─ page_urlstring必须商品轮播图
├─ is_negotiablenumber必须是否面议0.否|1.是
├─ is_levelnumber必须是否显示会员价0.否|1.是
├─ level_pricenumber必须会员价
├─ pricestring必须商品售价
├─ price_contentstring必须商品显示价
├─ is_salesstring必须是否显示销量0.否|1.是
├─ salesstring必须销量(包含虚拟销量)
├─ vip_card_appointobject必须超级会员卡
├─ discountnull非必须会员折扣
├─ is_my_vip_card_goodsnumber非必须登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_usernumber非必须登录用户是不是会员 1是 0否
├─ goods_stocknumber必须商品库存
├─ statusnumber必须商品上下架状态0.下架|1.上架
├─ mch_goodsobject必须多商户商品信息
├─ idnumber非必须商户商品ID
├─ statusnumber非必须商户商品状态0.申请上架|1.申请中|2.同意上架|3.拒绝上架
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

商品详情

基本信息

Path: /plugin/mch/api/goods/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页
mch_id 是 10 多商户ID
id 是 44 商品ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idstring非必须商品ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ goods_warehouse_idstring非必须关联商品库ID
├─ statusstring非必须上架状态:0=下架,1=上架
├─ pricestring非必须售价
├─ use_attrstring非必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring非必须商品规格组
├─ goods_stockstring非必须商品总库存(规格库存相加)
├─ virtual_salesstring非必须已出售量(虚拟销量)
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模板ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否单独设置会员价
├─ share_typestring非必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring非必须商品标示用于区分商品属于什么模块
├─ app_share_picstring非必须商品自定义分享图片
├─ app_share_titlestring非必须商品自定义分享标题
├─ is_default_servicesstring非必须默认服务 0.否|1.是
├─ sortstring非必须商品排序
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须统计 支付人数
├─ payment_numstring非必须统计 支付件数
├─ payment_amountstring非必须统计 支付金额
├─ payment_orderstring非必须支付订单数
├─ confine_order_countstring非必须限制下单数量
├─ is_area_limitstring非必须是否单独区域购买
├─ area_limitstring非必须区域限制详情 json格式
├─ share_level_typestring非必须合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_idstring非必须自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ cover_picstring非必须商品缩略图
├─ unitstring非必须商品单位
├─ detailstring非必须商品详情
├─ video_urlstring非必须商品视频链接
├─ level_shownumber非必须会员价是否显示
├─ is_salesnumber非必须销量是否显示
├─ attrobject []非必须规格

item 类型: object

├─ idnumber必须规格ID
├─ goods_idnumber必须商品ID
├─ sign_idstring必须规格组合,关联规格组
├─ stocknumber必须库存
├─ pricestring必须规格价
├─ nostring必须商品货号
├─ weightnumber必须商品重量
├─ pic_urlstring必须商品轮播图
├─ is_deletenumber必须
├─ attr_listobject []必须

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ price_membernumber必须
├─ member_price_liststring []必须

item 类型: string

├─ 非必须
├─ goods_numnumber非必须商品数量
├─ goods_nostring非必须商品货号
├─ goods_weightnumber非必须商品重量(单位:克)
├─ servicesstring []非必须商品服务

item 类型: string

├─ 非必须
├─ cardsstring []非必须商品赠送卡券

item 类型: string

├─ 非必须
├─ price_minnumber非必须商品最低价
├─ price_maxnumber非必须商品最高价
├─ pic_urlobject []非必须

item 类型: object

├─ pic_urlstring非必须
├─ idnumber非必须
├─ sharenumber非必须
├─ salesnumber非必须
├─ favoriteboolean非必须
├─ goods_marketingobject非必须
├─ limitstring非必须
├─ pickupstring非必须
├─ shippingstring非必须
├─ goods_marketing_awardobject非必须
├─ cardobject非必须
├─ titlestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ integralobject非必须
├─ titlestring非必须
├─ vip_card_appointobject非必须超级会员卡
├─ discountnull非必须会员折扣
├─ is_my_vip_card_goodsnumber非必须登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_usernumber非必须登录用户是不是会员 1是 0否

分类样式配置

基本信息

Path: /plugin/mch/api/goods/cat-style

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
mch_id 是 10 多商户ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ settingobject非必须
├─ cat_stylenumber非必须分类样式
├─ recommend_countnumber非必须推荐商品显示数量
├─ cat_goods_countnumber非必须分类商品显示数量
├─ cat_goods_colsnumber非必须显示行数

商品分类列表

基本信息

Path: /api/default/cats-list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
mch_id 是 10 多商户ID
cat_id 否 0 0.全部

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ settingobject非必须
├─ cat_stylenumber非必须分类样式
├─ recommend_countnumber非必须推荐商品显示数量
├─ cat_goods_countnumber非必须分类商品显示数量
├─ cat_goods_colsnumber非必须显示行数

商城-多商户设置

基本信息

Path: /plugin/mch/api/mch/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ settingobject非必须
├─ cash_typestring []非必须提现类型:auto自动打款|wx微信线下转账|alipay|支付宝线下转账|bank银行卡|balance余额

item 类型: string

├─ 非必须
├─ descstring非必须入驻协议
├─ is_servicenumber非必须是否开启客服图标0.否|1.是
├─ form_dataobject []非必须自定义表单

item 类型: object

├─ keystring必须
├─ key_namestring必须
├─ namestring必须
├─ is_requiredstring必须
├─ img_typestring必须
├─ listobject []必须

item 类型: object

├─ labelstring必须
├─ valuestring必须
├─ is_informationnumber非必须是否开启自定义审核资料0.否|1.j
├─ is_distancenumber非必须是否开启商户距离排序0.否|1.是
├─ statusstring非必须

添加访客记录

基本信息

Path: /plugin/mch/api/mch/add-visit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 是 10 商户ID

返回数据

名称类型是否必须默认值备注其他信息

商品上下架

基本信息

Path: /plugin/mch/api/goods/switch-status

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
page 否 1 分页
mch_id 是 10 多商户ID
id 是 44 商品ID

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 是 10 多商户ID
id text 是 1 商品ID

返回数据

名称类型是否必须默认值备注其他信息

商品删除

基本信息

Path: /plugin/mch/api/goods/destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
page 否 1 分页
mch_id 是 10 多商户ID
id 是 44 商品ID

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 是 10 多商户ID
id text 是 1 商品ID

返回数据

名称类型是否必须默认值备注其他信息

商户订单详情

基本信息

Path: /plugin/mch/api/order/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页
mch_id 是 10 多商户ID
id 是 44 订单ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ mch_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ express_original_pricestring非必须
├─ express_pricestring非必须
├─ total_goods_pricestring非必须
├─ total_goods_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ use_user_coupon_idstring非必须
├─ coupon_discount_pricestring非必须
├─ use_integral_numstring非必须
├─ integral_deduction_pricestring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ remarkstring非必须
├─ order_formstring非必须
├─ wordsstring非必须
├─ seller_remarkstring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_sendstring非必须
├─ send_timestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ is_salestring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ cancel_statusstring非必须
├─ cancel_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_recyclestring非必须
├─ is_offlinestring非必须
├─ offline_qrcodestring非必须
├─ clerk_idstring非必须
├─ store_idstring非必须
├─ signstring非必须
├─ tokenstring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infoobject非必须
├─ namestring非必须
├─ numstring非必须
├─ total_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ refundnull非必须
├─ status_textstring非必须
├─ pay_type_textstring非必须
├─ goods_numnumber非必须

商户订单列表

基本信息

Path: /plugin/mch/api/order/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页
mch_id 是 10 多商户ID
status 是 0 0.全部
order_type 否 order order:普通订单(默认)
refund_status 否 all all:全部(默认)
keyword 否 8219312938 订单号搜索
start_date 否 2019-06-01 开始时间
end_date 否 2019-07-01 结束时间

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ mch_idstring必须
├─ order_nostring必须
├─ total_pricestring必须
├─ total_pay_pricestring必须
├─ express_original_pricestring必须
├─ express_pricestring必须
├─ total_goods_pricestring必须
├─ total_goods_original_pricestring必须
├─ member_discount_pricestring必须
├─ use_user_coupon_idstring必须
├─ coupon_discount_pricestring必须
├─ use_integral_numstring必须
├─ integral_deduction_pricestring必须
├─ namestring必须
├─ mobilestring必须
├─ addressstring必须
├─ remarkstring必须
├─ order_formstring必须
├─ wordsstring必须
├─ seller_remarkstring必须
├─ is_paystring必须
├─ pay_typestring必须
├─ pay_timestring必须
├─ is_sendstring必须
├─ send_timestring必须
├─ expressstring必须
├─ express_nostring必须
├─ is_salestring必须
├─ is_confirmstring必须
├─ confirm_timestring必须
├─ cancel_statusstring必须
├─ cancel_timestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_recyclestring必须
├─ is_offlinestring必须
├─ offline_qrcodestring必须
├─ clerk_idstring必须
├─ store_idstring必须
├─ signstring必须
├─ tokenstring必须
├─ detailobject []必须

item 类型: object

├─ idstring必须
├─ order_idstring必须
├─ goods_idstring必须
├─ numstring必须
├─ unit_pricestring必须
├─ total_original_pricestring必须
├─ total_pricestring必须
├─ member_discount_pricestring必须
├─ goods_infoobject必须
├─ namestring非必须
├─ numstring非必须
├─ total_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ pic_urlstring非必须
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ commentsstring []必须

item 类型: string

├─ 非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

店铺二维码

基本信息

Path: /plugin/mch/api/mch/qr-code

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
mch_id 是 10 商户ID

返回数据

名称类型是否必须默认值备注其他信息

获取二维码参数

基本信息

Path: /api/default/qr-code-parameter

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
token 否 parameter 二维码标识

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ user_idnumber非必须
├─ tokenstring非必须
├─ dataobject非必须
├─ idstring非必须
├─ created_atstring非必须

店铺统计

基本信息

Path: /plugin/mch/api/mch/statistic

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
mch_id 是 10 多商户ID
monthly 是 1 月份

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ monthly_order_pay_price_countnumber非必须当月成交额
├─ monthly_order_pay_price_averagenumber非必须当月每日平均成交额
├─ trend_arrnumber []非必须价格走势

item 类型: number

├─ 非必须
├─ contrast_prev_monthlynumber非必须与上月相差金额

我的店铺首页

基本信息

Path: /plugin/mch/api/mch/manage-index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
mch_id 是 10 多商户ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ monthly_order_pay_price_countnumber非必须当月成交额
├─ monthly_order_pay_price_averagenumber非必须当月每日平均成交额
├─ trend_arrnumber []非必须价格走势

item 类型: number

├─ 非必须
├─ contrast_prev_monthlynumber非必须与上月相差金额

数据统计

数据统计-店铺查询

基本信息

Path: /mall/data-statistics/mch_list

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 否 模糊查询参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ mch_listobject []非必须

item 类型: object

├─ idstring非必须
├─ namestring非必须

合伙人排行

基本信息

Path: /mall/share-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 否 合伙人名
order text 否 order=price desc 排序字段
flag text 否 flag=EXPORT 导出字段
fields text 否 fields=id,name 需要导出的字段
page text 否 分页,需要get传值
platform text 否 wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须ID
├─ namestring必须合伙人
├─ total_moneystring必须累计佣金
├─ first_childrenstring必须直接下级数量
├─ all_childrenstring必须总下级数量
├─ all_moneystring必须总佣金
├─ all_orderstring必须合伙人订单数
├─ pricestring必须已提现佣金
├─ export_listobject []非必须导出字段列表

item 类型: object

├─ keystring必须
├─ valuestring必须

商品分类列表

基本信息

Path: /mall/order-statistics/cats_list

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
cats_ids text 否 cats_ids=1或=1,2 分类id,多id使用英文逗号隔开
cats_name text 否 分类名称模糊查询

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ namestring非必须分类名称

头部公告

基本信息

Path: /mall/data-statistics/notice

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ firststring []非必须

item 类型: string

├─ 非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ mall_noticestring非必须
├─ paginationnull非必须

头部总览数据

基本信息

Path: /mall/data-statistics/all-data

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ user_countstring非必须用户数
├─ goods_numstring非必须商品数
├─ order_numstring非必须订单数
├─ pay_numstring非必须支付件数
├─ pay_pricestring非必须支付金额
├─ wait_send_numstring非必须代发货数
├─ wait_pay_numstring非必须待支付数
├─ pro_orderstring非必须售后数

对账单

基本信息

Path: /mall/price-statistics/index

Method: POST

接口描述:
undefined

请求参数

幸运抽奖

基本信息

Path: /mall/lottery-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否
date_end text 否
name text 否
flag text 否
page text 否
order text 否

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须商品名称
├─ cover_picstring必须图片
├─ attr_groupsstring必须规格
├─ participantstring必须参与人数
├─ inviteestring必须被邀请人数
├─ code_numstring必须奖卷
├─ statusstring必须状态

拼团

基本信息

Path: /mall/pintuan-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否
date_end text 否
name text 否
order text 否
flag text 否
page text 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须商品名称
├─ cover_picstring必须图片
├─ all_userstring必须拼团人数
├─ success_userstring必须成团人数
├─ pay_userstring必须支付人数
├─ goods_numstring必须支付件数
├─ total_pay_pricestring必须支付金额
├─ statusstring必须状态
├─ success_100string必须成团率

插件菜单

基本信息

Path: /mall/data-statistics/plugin-menus

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
menusobject []非必须

item 类型: object

├─ namestring必须
├─ keystring必须
├─ pic_urlstring必须
├─ routestring必须

数据统计

基本信息

Path: /mall/data-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否 开始时间
date_end text 否 结束时间
mch_id text 否 店铺ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ goods_top_listobject []非必须商品购买力TOP表

item 类型: object

├─ namestring必须商品
├─ total_pricestring必须销售额
├─ numstring必须销售量
├─ user_top_listobject []非必须用户购买力TOP表

item 类型: object

├─ nicknamestring必须用户
├─ avatarstring必须头像
├─ total_pricestring必须支付金额
├─ numstring必须购买件数

数据统计-商品排序导出

基本信息

Path: /mall/data-statistics/goods_top

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 否 店铺ID
date_start text 否 开始时间
date_end text 否 结束时间
goods_order text 否 order=total_price DESC 排序
flag text 否 flag=EXPORT 导出标签

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ all_datanull非必须
├─ mch_listnull非必须
├─ goods_top_listobject []非必须

item 类型: object

├─ namestring必须商品
├─ total_pricestring必须销售额
├─ numstring必须销售量
├─ user_top_listnull非必须
├─ table_listnull非必须

数据统计-图表

基本信息

Path: /mall/data-statistics/table

Method: POST

接口描述:

默认返回昨日数据

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 否
date_start text 否
date_end text 否
type text 否 1支付数据,2收益数据

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ created_atstring必须x轴时间
├─ user_numstring必须支付人数
├─ order_numstring必须支付订单数
├─ total_pay_pricestring必须支付金额
├─ goods_numstring必须支付件数
├─ table_dataobject必须图表总数据
├─ user_numstring必须支付人数
├─ order_numstring必须支付订单数
├─ total_pay_pricestring必须支付金额
├─ goods_numstring必须支付件数

发放统计

基本信息

Path: /mall/send-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 否 名称
date_start text 否 开始时间
date_end text 否 结束时间
type text 否 coupon 优惠卷,card 卡卷
flag text 否 EXPORT EXPORT
page text 否 分页,需要get传值
platform text 否 wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ all_dataobject必须总发放
├─ all_numstring必须
├─ unuse_numstring必须
├─ use_numstring必须
├─ end_numstring必须
├─ listobject []非必须

item 类型: object

├─ datestring必须日期
├─ namestring必须名称
├─ all_numstring必须发放总数
├─ unuse_numstring必须未使用数
├─ use_numstring必须已使用数
├─ end_numstring必须失效数

数据统计-用户排序导出

基本信息

Path: /mall/data-statistics/users_top

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mch_id text 是 店铺ID
date_start text 是 开始时间
date_end text 是 结束时间
user_order text 是 order=total_price DESC 排序
flag text 是 flag=EXPORT 导出标签
platform text 否 wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ all_datanull非必须
├─ mch_listnull非必须
├─ goods_top_listnull非必须
├─ user_top_listobject []非必须

item 类型: object

├─ nicknamestring必须用户
├─ total_pricestring必须支付金额
├─ numstring必须购买件数
├─ table_listnull非必须

整点秒杀

基本信息

Path: /mall/miaosha-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否 开始时间
date_end text 否 结束时间
name text 否 商品名称
order text 否 排序字段
flag text 否 EXPORT 导出
page text 否 分页,需要get传值

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ miaosha_timestring必须秒杀时间
├─ cover_picstring必须图片
├─ namestring必须商品名称
├─ user_numstring必须支付人数
├─ goods_numstring必须支付件数
├─ pay_pricestring必须支付金额
├─ statusstring必须状态

步数兑换

基本信息

Path: /mall/step-statistics/ex

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
data_start text 否
data_end text 否
flag text 否
page text 否

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ all_dataobject非必须
├─ c_datestring非必须
├─ step_numstring非必须总兑换步数
├─ user_numstring非必须兑换人数
├─ goods_numstring非必须兑换商品数
├─ goods_paystring非必须兑换金额/活力币
├─ listobject []非必须

item 类型: object

├─ c_datestring必须
├─ step_numstring必须
├─ user_numstring必须
├─ goods_numstring必须
├─ goods_paystring必须

步数挑战

基本信息

Path: /mall/step-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
data_start text 否
data_end text 否
name text 否
flag text 否
page text 否

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ begin_atstring非必须活动时间
├─ titlestring非必须活动名称
├─ step_numstring非必须挑战步数
├─ currencystring非必须奖金池
├─ participate_numstring非必须参与人数
├─ success_numstring非必须成功人数
├─ put_currencystring非必须报名活力币

砍价

基本信息

Path: /mall/bargain-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否
date_end text 否
name text 否
order text 否
flag text 否
page text 否

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须商品名称
├─ cover_picstring必须图片
├─ attr_groupsstring必须规格
├─ min_pricestring必须活动价
├─ initiatorstring必须发起人数
├─ participantstring必须参与人数
├─ min_price_goodsstring必须砍到最低商品数
├─ underwaystring必须进行中活动数
├─ successstring必须成功活动数
├─ failstring必须失败活动数
├─ payment_peoplestring必须支付人数
├─ payment_numstring必须支付件数
├─ payment_amountstring必须支付金额
├─ statusstring必须状态

积分商城

基本信息

Path: /mall/integral-statistics/mall

Method: POST

接口描述:

未安装相关插件,接口会500报错

{
"code": 500,
"msg": "插件integral_mall1相关类Plugin不存在。",
"data": null,
"error": [
"#162: E:/foal_store/core/Plugin.php",
"#0: app\\controllers\\mall\\IntegralStatisticsController->actionMall()",
"#57: E:/foal_store/vendor/yiisoft/yii2/base/InlineAction.php",
"#157: E:/foal_store/vendor/yiisoft/yii2/base/Controller.php",
"#528: E:/foal_store/vendor/yiisoft/yii2/base/Module.php",
"#233: E:/foal_store/core/Application.php",
"#103: E:/foal_store/vendor/yiisoft/yii2/web/Application.php",
"#386: E:/foal_store/vendor/yiisoft/yii2/base/Application.php",
"#16: E:/foal_store/web/index.php"
]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否 开始时间
date_end text 否 结束时间
flag text 否 EXPORT EXPORT
page text 否 分页,需要get传值
platform text 否 wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ all_dataobject []非必须总兑换

item 类型: object

├─ coupons_numstring非必须
├─ user_numstring非必须
├─ goods_numstring非必须
├─ goods_integralstring非必须
├─ goods_pricestring非必须
├─ listobject []非必须

item 类型: object

├─ datestring必须日期
├─ coupons_numstring必须兑换优惠卷数
├─ user_numstring必须兑换商品人数
├─ goods_numstring必须兑换商品数
├─ goods_integralstring必须兑换支出积分
├─ goods_pricestring必须兑换支出金额

积分收支

基本信息

Path: /mall/integral-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否
date_end text 否
flag text 否 EXPORT EXPORT
page text 否 分页,需要get传值
platform text 否 wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ all_dataobject []非必须总收支

item 类型: object

├─ in_integralstring非必须总收入
├─ out_integralstring非必须总支出
├─ listobject []非必须

item 类型: object

├─ datestring必须日期
├─ in_integralstring必须积分收入
├─ out_integralstring必须积分支出

经营概况

基本信息

Path: /mall/data-statistics/all-num

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
is_store text 否 1门店页面
mch_id text 否 门店ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ order_dataobject非必须
├─ user_numstring非必须
├─ order_numstring非必须
├─ total_pay_pricestring非必须
├─ goods_numstring非必须
├─ user_num_statusstring非必须
├─ order_num_statusstring非必须
├─ total_pay_price_statusstring非必须
├─ goods_num_statusstring非必须
├─ user_dataobject非必须
├─ user_numstring非必须
├─ data_numstring非必须
├─ user_num_statusstring非必须
├─ data_num_statusstring非必须
├─ pay_dataobject非必须
├─ 1object非必须
├─ amount_statusstring非必须
├─ amountstring非必须
├─ refundstring非必须
├─ 2object非必须
├─ amount_statusstring非必须
├─ amountstring非必须
├─ refundstring非必须
├─ 3object非必须
├─ amount_statusstring非必须
├─ amountstring非必须
├─ refundstring非必须
├─ 4object非必须
├─ amount_statusstring非必须
├─ amountstring非必须
├─ refundstring非必须

裂变拆红包

基本信息

Path: /mall/fxhb-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否 开始时间
date_end text 否 结束时间
name text 否 活动名称
flag text 否 EXPORT EXPORT
page text 否 分页,需要get传值
platform text 否 wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ start_timestring必须活动开始时间
├─ end_timestring必须活动结束时间
├─ namestring必须活动名称
├─ numberstring必须所需人数
├─ launch_user_numstring必须发起人数
├─ participate_numstring必须参与人数
├─ launch_numstring必须发起数量
├─ success_numstring必须成功数量
├─ coupon_numstring必须发放优惠卷数量
├─ coupon_pricestring必须发放优惠卷总金额
├─ statusstring必须状态

销售统计-门店-多商户

基本信息

Path: /mall/order-statistics/index

Method: POST

接口描述:

"sign": "booking"               预约订单

"sign": "integral_mall"       积分商城

"sign": "miaosha"              秒杀订单

"sign": "pintuan"                拼团订单

"sign": "bargain"                砍价订单

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否 开始时间
date_end text 否 结束时间
status text 否 状态 -1全部,0未完成,1已完成,3已取消,4售后中,5售后完成
flag text 否 导出字段 EXPORT
fields text 否 fields=id,name 需要导出的字段
page text 否 分页,需要get传值
mch_id text 否 多商户
store_id text 否 门店
platform text 否 wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ plugins_listobject []必须插件列表

item 类型: object

├─ signstring必须看备注字段说明
├─ namestring必须名称
├─ allobject非必须总成交
├─ user_numstring非必须
├─ order_numstring非必须
├─ total_pay_pricestring非必须
├─ goods_numstring非必须
├─ nowobject非必须今日成交
├─ user_numstring非必须
├─ order_numstring非必须
├─ total_pay_pricestring非必须
├─ goods_numstring非必须
├─ listobject []非必须

item 类型: object

├─ created_atstring必须日期
├─ user_numstring必须付款人数
├─ order_numstring必须付款订单数
├─ total_pay_pricestring必须付款金额
├─ goods_numstring必须付款件数
├─ export_listobject []非必须导出字段列表

item 类型: object

├─ keystring必须
├─ valuestring必须

预约

基本信息

Path: /mall/booking-statistics/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 否
date_end text 否
name text 否
order text 否
flag text 否
page text 否

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须商品名称
├─ cover_picstring必须图片
├─ pay_userstring必须支付人数
├─ goods_numstring必须支付件数
├─ total_pay_pricestring必须支付金额

小程序管理界面

商品编辑获取配置

基本信息

Path: /admin/goods/goods-config

Method: GET

接口描述:

电子卡密插件新增:is_ecard、ecard_api_url;

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须
msgstring必须
dataobject必须
├─ is_ecardinteger必须是否可使用电子卡密
├─ ecard_api_urlstring必须小程序端请求路径

会员列表

基本信息

Path: /api/admin/user/all-member

Method: GET

接口描述:

订单消息跳转到订单列表的时候,带订单号过去直接查询,并根据状态如下进行状态显示
is_pay = 0  未付款
is_pay = 1 或者 pay_type = 2  已付款



售后消息跳转到售后列表

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ mch_idstring必须
├─ order_nostring必须
├─ total_pricestring必须
├─ total_pay_pricestring必须
├─ express_pricestring必须
├─ total_goods_pricestring必须
├─ total_goods_original_pricestring必须
├─ member_discount_pricestring必须
├─ use_user_coupon_idstring必须
├─ coupon_discount_pricestring必须
├─ use_integral_numstring必须
├─ integral_deduction_pricestring必须
├─ namestring必须
├─ mobilestring必须
├─ addressstring必须
├─ remarkstring必须
├─ order_formobject,null必须
├─ wordsstring必须
├─ seller_remarkstring必须
├─ is_paystring必须
├─ pay_typestring必须
├─ pay_timestring必须
├─ is_sendstring必须
├─ send_timestring必须
├─ expressstring必须
├─ express_nostring必须
├─ is_salestring必须
├─ is_confirmstring必须
├─ confirm_timestring必须
├─ cancel_statusstring必须
├─ cancel_timestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_recyclestring必须
├─ is_offlinestring必须
├─ offline_qrcodestring必须
├─ clerk_idstring必须
├─ store_idstring必须
├─ tokenstring必须
├─ nicknamestring必须用户昵称
├─ detailobject []必须订单详情信息(备注见order_detail)

item 类型: object

├─ idstring必须
├─ order_idstring必须
├─ goods_idstring必须
├─ numstring必须
├─ unit_pricestring必须
├─ total_original_pricestring必须
├─ total_pricestring必须
├─ member_discount_pricestring必须
├─ goods_infostring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ goodsobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ sortstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_levelstring非必须
├─ confine_countstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ is_negotiablestring非必须
├─ freight_idstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ refundnull必须商品售后情况
├─ attr_listobject []必须商品规格

item 类型: object

├─ attr_group_namestring必须规格组
├─ attr_group_idnumber,string必须
├─ attr_idnumber,string必须
├─ attr_namestring必须规格名
├─ clerkobject必须核销人信息
├─ field_2string必须
├─ storeobject必须门店信息
├─ exportListstring []非必须导出信息(未处理)

item 类型: string

├─ 非必须

门店列表

基本信息

Path: /api/admin/user/store

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息

退货退款订单确认收货

基本信息

Path: /api/admin/order/shou-huo

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
refund_order_id text 是 1 售后订单ID

返回数据

名称类型是否必须默认值备注其他信息

评价置顶

基本信息

Path: /admin/order-comments/update-top

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
status text 是 1 是否置顶0.否
id text 是 1 评价ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

订单添加备注

基本信息

Path: /api/admin/order/seller-remark

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 1 订单ID
seller_remark text 是 备注信息 备注信息

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ valuestring必须
├─ labelstring必须
├─ childrenobject []必须

item 类型: object

├─ valuestring必须
├─ labelstring必须
├─ childrenobject []必须

item 类型: object

├─ valuestring必须
├─ labelstring必须

订单发货

基本信息

Path: /api/admin/order/send

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 152 订单ID
mch_id text 是 10 多商户ID
express text 是 顺丰速运
customer_name text 是 快递为京东物流时需填写
express_no text 是 218371209380918
words text 否 备注
is_express text 是 是否快递发货0.否
order_detail_id text 是 [1,2] 商品详情ID 类型:Array
express_content text 是 物流备注 无需物流备注
express_id text 是 1 分批物流编辑时,传物流ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ namestring必须
├─ codestring必须

后台绑定管理员

基本信息

Path: /admin/user/bind

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
user_id text 是 用户ID
we7_user_id text 否 微擎User ID 独立版不传

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

后台解绑管理员

基本信息

Path: /admin/user/destroy-bind

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 用户ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

解除核销员

基本信息

Path: /api/admin/user/clerkdestroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 61 用户id

返回数据

名称类型是否必须默认值备注其他信息
field_1string必须

获取面单

基本信息

Path: /api/admin/order/print

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
order_id 是 1 订单ID
express 是 顺丰速运 快递公司
mch_id 是 1

返回数据

名称类型是否必须默认值备注其他信息

获取提现消息tab栏

基本信息

Path: /api/admin/cash/tabs

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ typeidnumber必须
├─ typestring必须

队长审核队列查询

基本信息

Path: /api/admin/review/queue-status

Method: GET

接口描述:
undefined

请求参数

商品详情

基本信息

Path: /api/admin/goods/edit

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
id 是 1 商品ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ mall_idnumber非必须商城ID
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ cost_pricestring非必须商品成本价
├─ detailstring非必须商品详情
├─ cover_picstring非必须商品缩略图
├─ pic_urlobject []非必须商品轮播图

item 类型: object

├─ idstring非必须
├─ pic_urlstring非必须url
├─ video_urlstring非必须商品视频
├─ unitstring非必须单位
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ mch_idnumber非必须商户ID
├─ goods_warehouse_idnumber非必须商品库ID
├─ statusstring非必须上架状态:0=下架,1=上架
├─ pricestring非必须售价
├─ use_attrstring非必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring非必须商品规格组
├─ goods_stockstring非必须商品总库存(规格库存相加)
├─ virtual_salesstring非必须已出售量(虚拟销量)
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模板ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否单独设置会员价
├─ share_typestring非必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring非必须商品标示用于区分商品属于什么模块
├─ app_share_picstring非必须商品自定义分享图片
├─ app_share_titlestring非必须商品自定义分享标题
├─ is_default_servicesstring非必须默认服务 0.否|1.是
├─ sortstring非必须商品排序
├─ payment_peoplestring非必须统计 支付人数
├─ payment_numstring非必须统计 支付件数
├─ payment_amountstring非必须统计 支付金额
├─ payment_orderstring非必须支付订单数
├─ confine_order_countstring非必须限制下单数量
├─ is_area_limitstring非必须是否单独区域购买
├─ area_limitstring非必须区域限制详情 json格式
├─ share_level_typestring非必须合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_idstring非必须自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ attrobject []非必须

item 类型: object

├─ idnumber非必须规格ID
├─ goods_idnumber非必须商品ID
├─ sign_idstring非必须规格组合,关联规格组
├─ stocknumber非必须库存
├─ pricestring非必须规格价
├─ nostring非必须商品货号
├─ weightnumber非必须商品重量
├─ pic_urlstring非必须商品轮播图
├─ is_deletenumber非必须
├─ attr_listobject []非必须规格组信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ price_membernumber非必须会员价
├─ member_price_listobject []非必须

item 类型: object

├─ idnumber必须
├─ levelnumber必须
├─ pricestring必须
├─ goods_attr_idnumber必须
├─ is_deletenumber必须
├─ goods_idnumber必须
├─ member_priceobject非必须
├─ level2number非必须
├─ level3number非必须
├─ share_commission_firstnumber非必须
├─ share_commission_secondnumber非必须
├─ share_commission_thirdnumber非必须
├─ share_commission_firststring非必须一级合伙人金额
├─ share_commission_secondstring非必须二级合伙人金额
├─ share_commission_thirdstring非必须三级合伙人金额
├─ member_priceobject非必须自定义会员价
├─ level2number非必须
├─ level3number非必须
├─ goods_nostring非必须商品货号
├─ goods_weightnumber非必须商品重量
├─ goods_numnumber非必须商品数量
├─ goods_warehouseobject非必须商品库商品信息
├─ goods_idnumber非必须商品ID
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ attr_groupsobject []非必须商品规格组

item 类型: object

├─ attr_group_idnumber非必须
├─ attr_group_namestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ catsobject []非必须商品分类

item 类型: object

├─ labelstring非必须
├─ valuenumber非必须
├─ mchCatsstring []非必须商户分类信息

item 类型: string

├─ 非必须
├─ servicesstring []非必须商品服务信息

item 类型: string

├─ 非必须
├─ cardsstring []非必须商品卡券信息

item 类型: string

├─ 非必须
├─ freightobject非必须运费规则
├─ idnumber非必须规则ID
├─ namestring非必须规则名称
├─ attr_default_namestring非必须
├─ is_vip_card_goodsnumber非必须
├─ is_quick_shopnumber非必须是否加入快速购买0.否|1.是
├─ is_sell_wellnumber非必须是否热销0.否|1.是
├─ is_negotiablenumber非必须是否面议0.否|1.是

确认收货

基本信息

Path: /api/admin/order/confirm

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
order_id 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 订单ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

审核消息列表--第二版

基本信息

Path: /api/admin/v2/review/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
key 是 share 请求数据标示
keyword 否 名称搜索
page 否 1 页码

返回数据

名称类型是否必须默认值备注其他信息

审核消息处理--第二版

基本信息

Path: /api/admin/v2/review/switch-status

Method: GET

接口描述:
undefined

请求参数

审核消息详情--第二版

基本信息

Path: /api/admin/v2/review/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
key 是 mch 插件标示
id 否 多商户id
user_id 否 待审核人员的用户id

返回数据

名称类型是否必须默认值备注其他信息

提现审核

基本信息

Path: /api/admin/cash/verify

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
type text 是 1 1为入驻商 2为合伙人

返回数据

名称类型是否必须默认值备注其他信息

提现审核与打款(新)

基本信息

Path: /api/admin/cash/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
status text 是 1 1:同意

2:打款
3:拒绝 |
| model_type | text | 是 | | mch:多商户
share:合伙人
bonus:团队分红
stock:股东分红
region:区域代理 |
| content | text | 否 | 备注内容 | |

返回数据

名称类型是否必须默认值备注其他信息

提现审核列表

基本信息

Path: /api/admin/cash/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
type 是 1 1为入驻商 2为合伙人
status 是 0 0为未审核 1为打款中

返回数据

名称类型是否必须默认值备注其他信息

提现审核列表(新)

基本信息

Path: /api/admin/cash/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1
status 是 3
keyword 否
model_type 是 mch mch:多商户
share:合伙人
bonus:团队分红
stock:股东分红
region:区域代理

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ order_nostring必须
├─ pay_typestring必须
├─ typestring必须
├─ statusnumber必须
├─ userobject必须
├─ namestring非必须
├─ phonestring非必须
├─ avatarstring非必须
├─ nicknamestring非必须
├─ platformstring非必须
├─ cashobject必须
├─ pricenumber非必须
├─ service_chargenumber非必须
├─ actual_pricenumber非必须
├─ extraobject必须
├─ namestring非必须
├─ mobilestring非必须
├─ bank_namestring非必须
├─ timeobject必须
├─ created_atstring非必须
├─ apply_atstring非必须
├─ remittance_atstring非必须
├─ reject_atstring非必须
├─ contentobject必须
├─ apply_contentstring非必须
├─ remittance_contentstring非必须
├─ reject_contentstring非必须
├─ modelstring必须
├─ model_textstring必须
├─ remarknull,string必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ export_listobject []非必须

item 类型: object

├─ keystring必须
├─ valuestring必须

更新用户备注名

基本信息

Path: /api/admin/user/update-user-remark-name

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 1 用户ID
remark 是 备注信息

Body

参数名称 参数类型 是否必须 示例 备注
remark_name text 是 备注名 备注名
id text 是 1 用户ID

返回数据

名称类型是否必须默认值备注其他信息

更新用户备注

基本信息

Path: /api/admin/user/update-user-remark

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 1 用户ID
remark 是 备注信息

Body

参数名称 参数类型 是否必须 示例 备注
remark text 是 联系157.. 备注
id text 是 1 用户ID

返回数据

名称类型是否必须默认值备注其他信息

更新用户会员等级

基本信息

Path: /api/admin/user/update-user-level

Method: POST

接口描述:

订单消息跳转到订单列表的时候,带订单号过去直接查询,并根据状态如下进行状态显示
is_pay = 0  未付款
is_pay = 1 或者 pay_type = 2  已付款



售后消息跳转到售后列表

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 1 用户ID
member_level 是 1 会员等级

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ mch_idstring必须
├─ order_nostring必须
├─ total_pricestring必须
├─ total_pay_pricestring必须
├─ express_pricestring必须
├─ total_goods_pricestring必须
├─ total_goods_original_pricestring必须
├─ member_discount_pricestring必须
├─ use_user_coupon_idstring必须
├─ coupon_discount_pricestring必须
├─ use_integral_numstring必须
├─ integral_deduction_pricestring必须
├─ namestring必须
├─ mobilestring必须
├─ addressstring必须
├─ remarkstring必须
├─ order_formobject,null必须
├─ wordsstring必须
├─ seller_remarkstring必须
├─ is_paystring必须
├─ pay_typestring必须
├─ pay_timestring必须
├─ is_sendstring必须
├─ send_timestring必须
├─ expressstring必须
├─ express_nostring必须
├─ is_salestring必须
├─ is_confirmstring必须
├─ confirm_timestring必须
├─ cancel_statusstring必须
├─ cancel_timestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_recyclestring必须
├─ is_offlinestring必须
├─ offline_qrcodestring必须
├─ clerk_idstring必须
├─ store_idstring必须
├─ tokenstring必须
├─ nicknamestring必须用户昵称
├─ detailobject []必须订单详情信息(备注见order_detail)

item 类型: object

├─ idstring必须
├─ order_idstring必须
├─ goods_idstring必须
├─ numstring必须
├─ unit_pricestring必须
├─ total_original_pricestring必须
├─ total_pricestring必须
├─ member_discount_pricestring必须
├─ goods_infostring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ goodsobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ sortstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_levelstring非必须
├─ confine_countstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ is_negotiablestring非必须
├─ freight_idstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ refundnull必须商品售后情况
├─ attr_listobject []必须商品规格

item 类型: object

├─ attr_group_namestring必须规格组
├─ attr_group_idnumber,string必须
├─ attr_idnumber,string必须
├─ attr_namestring必须规格名
├─ clerkobject必须核销人信息
├─ field_2string必须
├─ storeobject必须门店信息
├─ exportListstring []非必须导出信息(未处理)

item 类型: string

├─ 非必须

首页总览数据

基本信息

Path: /api/admin/data-statistics/all_data

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
date_start text 是
date_end text 是
sign text 是 插件分类查询

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ plugins_listobject []非必须

item 类型: object

├─ signstring必须插件参数
├─ namestring必须插件名称
├─ all_dataobject非必须
├─ user_countstring非必须总用户数
├─ goods_numstring非必须商品数
├─ order_numstring非必须总订单数
├─ pay_numstring非必须支付订单数
├─ wait_send_numstring非必须代发货数
├─ pro_orderstring非必须维权订单数
├─ pay_pricestring非必须支付金额
├─ wait_pay_numstring非必须代付款订单数
├─ new_msg_numobject非必须
├─ order_numnumber必须新订单数
├─ cash_numnumber必须
├─ review_numnumber必须

物流列表

基本信息

Path: /api/order/express-list

Method: GET

接口描述:
undefined

请求参数

获取商品列表

基本信息

Path: /api/admin/goods/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
page 否 1
search 否 {"keyword":"","status":""} keyword:模糊搜索
status 0为下架中 1为上架中

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ mch_idnumber必须
├─ goods_warehouse_idnumber必须
├─ statusnumber必须
├─ pricestring必须
├─ use_attrnumber必须
├─ attr_groupsstring必须
├─ goods_stocknumber必须
├─ virtual_salesnumber必须
├─ confine_countnumber必须
├─ piecesnumber必须
├─ foreheadstring必须
├─ freight_idnumber必须
├─ give_integralnumber必须
├─ give_integral_typenumber必须
├─ forehead_integralnumber必须
├─ forehead_integral_typenumber必须
├─ accumulativenumber必须
├─ individual_sharenumber必须
├─ attr_setting_typenumber必须
├─ is_levelnumber必须
├─ is_level_alonenumber必须
├─ share_typenumber必须
├─ signstring必须
├─ app_share_picstring必须
├─ app_share_titlestring必须
├─ is_default_servicesnumber必须
├─ sortnumber必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ payment_peoplenumber必须
├─ payment_numnumber必须
├─ payment_amountstring必须
├─ payment_ordernumber必须
├─ goodsWarehouseobject必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ mchGoodsnull []必须

item 类型: null

├─ 非必须
├─ catsobject []必须

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ mch_idnumber必须
├─ parent_idnumber必须
├─ namestring必须
├─ pic_urlstring必须
├─ sortnumber必须
├─ big_pic_urlstring必须
├─ advert_picstring必须
├─ advert_urlstring必须
├─ statusnumber必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ mchCatsstring []必须

item 类型: string

├─ 非必须
├─ mallGoodsobject必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ goods_idnumber非必须
├─ is_quick_shopnumber非必须
├─ is_sell_wellnumber非必须
├─ is_negotiablenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ namestring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

商品上下架

基本信息

Path: /api/admin/goods/switch-status

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
status text 是 1 1上架 0下架
id text 是 1028 商品id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

删除商品

基本信息

Path: /api/admin/goods/destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1028 商品id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

评价列表

基本信息

Path: /api/admin/order-comments/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
is_reply 否 1 0未回复(默认) 1已回复
score 否 1 1差评 2中评 3好评(默认)
page 否 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ order_idstring非必须
├─ order_detail_idstring非必须
├─ user_idstring非必须
├─ scorestring非必须
├─ contentstring非必须
├─ pic_urlstring []非必须

item 类型: string

├─ 非必须
├─ is_showstring非必须
├─ is_virtualstring非必须
├─ virtual_userstring非必须
├─ virtual_avatarstring非必须
├─ virtual_timestring非必须
├─ goods_idstring非必须
├─ goods_warehouse_idstring非必须
├─ signstring非必须
├─ reply_contentstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_anonymousstring非必须
├─ nicknamestring非必须
├─ namestring非必须
├─ cover_picstring非必须
├─ platformstring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

回复评论

基本信息

Path: /api/admin/order-comments/reply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 评论ID
reply_content text 是 回复内容

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

隐藏评价

基本信息

Path: /api/admin/order-comments/show

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 16 评价id
is_show text 是 1 0为隐藏 1为显示

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

用户列表

基本信息

Path: /api/admin/user/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
keyword 否 Andy 模糊搜索
sort 否 price_count_desc price_count_desc 支付金额降序

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ nicknamestring非必须
├─ mobilestring非必须
├─ member_levelstring非必须
├─ coupon_countstring非必须
├─ order_countstring非必须
├─ card_countstring非必须
├─ created_atstring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ mall_membersobject []非必须

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ levelnumber必须
├─ namestring必须
├─ auto_updatenumber必须
├─ moneystring必须
├─ discountstring必须
├─ statusnumber必须
├─ pic_urlstring必须
├─ is_purchasenumber必须
├─ pricestring必须
├─ rulesstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ exportListobject []非必须

item 类型: object

├─ keystring必须
├─ valuestring必须

合伙人

基本信息

Path: /api/admin/share/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
keyword 是 Andy

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ user_idnumber必须
├─ namestring必须
├─ mobilestring必须
├─ moneystring必须
├─ statusnumber必须
├─ total_moneystring必须
├─ contentnull必须
├─ is_deletenumber必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ apply_atstring必须
├─ become_atstring必须
├─ reasonstring必须
├─ first_childrennumber必须
├─ all_childrennumber必须
├─ all_moneystring必须
├─ all_ordernumber必须
├─ nicknamestring必须
├─ avatarstring必须
├─ parent_namestring必须
├─ firstnumber必须
├─ secondnumber必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ export_listobject []非必须

item 类型: object

├─ keystring必须
├─ valuestring必须

核销员列表

基本信息

Path: /api/admin/user/clerk

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ user_idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ card_countstring必须
├─ order_countstring必须
├─ userobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ storeobject []必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ namestring必须
├─ mobilestring必须
├─ addressstring必须
├─ province_idstring必须
├─ city_idstring必须
├─ district_idstring必须
├─ longitudestring必须
├─ latitudestring必须
├─ scorestring必须
├─ cover_urlstring必须
├─ pic_urlstring必须
├─ business_hoursstring必须
├─ descriptionstring必须
├─ scopestring必须
├─ is_defaultstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ total_pricenumber必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ store_listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ namestring必须
├─ mobilestring必须
├─ addressstring必须
├─ province_idstring必须
├─ city_idstring必须
├─ district_idstring必须
├─ longitudestring必须
├─ latitudestring必须
├─ scorestring必须
├─ cover_urlstring必须
├─ pic_urlstring必须
├─ business_hoursstring必须
├─ descriptionstring必须
├─ scopestring必须
├─ is_defaultstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须

用户积分充值/抵扣

基本信息

Path: /api/admin/user/integral

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
user_id text 是 61 用户id
num text 是 100 积分数量
type text 是 1 1为充值 0为扣除
remark text 否 备注信息

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

用户余额充值/抵扣

基本信息

Path: /api/admin/user/balance

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
user_id 是 61 用户id
type 是 1 1为充值 0为扣除
price 是 100 金额
remark 否 备注信息

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

获取商城配置

基本信息

Path: /api/admin/mall/setting

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须商城配置
├─ idstring非必须
├─ namestring非必须
├─ user_idstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_recyclestring非必须
├─ is_disablestring非必须
├─ optionobject []非必须

item 类型: object

├─ keystring必须
├─ valuearray,string,number必须
├─ settingobject非必须
├─ contact_telstring非必须
├─ over_timenumber非必须
├─ delivery_timenumber非必须
├─ after_sale_timenumber非必须
├─ payment_typestring []非必须

item 类型: string

├─ 非必须
├─ send_typestring非必须
├─ kdniao_mch_idstring非必须
├─ kdniao_api_keystring非必须
├─ member_integralstring非必须
├─ member_integral_rulestring非必须
├─ good_negotiablestring []非必须

item 类型: string

├─ 非必须
├─ mobile_verifystring非必须
├─ is_small_appstring非必须
├─ small_app_idstring非必须
├─ small_app_urlstring非必须
├─ small_app_picstring非必须
├─ is_customer_servicesstring非必须
├─ customer_services_picstring非必须
├─ is_dialstring非必须
├─ dial_picstring非必须
├─ is_web_servicestring非必须
├─ web_service_urlstring非必须
├─ web_service_picstring非必须
├─ is_quick_navigationstring非必须
├─ quick_navigation_stylestring非必须
├─ quick_navigation_picstring非必须
├─ cat_stylestring非必须
├─ recommend_countnumber非必须
├─ cat_goods_countnumber非必须
├─ cat_goods_colsnumber非必须
├─ is_member_pricestring非必须
├─ is_share_pricestring非必须
├─ is_purchase_framestring非必须
├─ is_commentstring非必须
├─ is_salesstring非必须
├─ is_recommendstring非必须
├─ is_mobile_authstring非必须
├─ is_official_accountstring非必须
├─ is_manual_mobile_authstring非必须
├─ is_quick_mapstring非必须
├─ quick_map_picstring非必须
├─ quick_map_addressstring非必须
├─ longitude_latitudestring非必须
├─ is_quick_homestring非必须
├─ quick_home_picstring非必须
├─ smsobject非必须短信配置
├─ statusstring非必须短信配置状态
├─ platformstring非必须
├─ access_key_idstring非必须
├─ access_key_secretstring非必须
├─ template_namestring非必须
├─ orderobject非必须
├─ template_idstring非必须
├─ template_variablestring非必须
├─ order_refundobject非必须
├─ template_idstring非必须
├─ template_variablestring非必须
├─ captchaobject非必须
├─ template_idstring非必须
├─ template_variablestring非必须
├─ mailobject非必须邮件配置
├─ mall_idnumber非必须
├─ mch_idnumber非必须

入驻商/合伙人审核 列表

基本信息

Path: /api/admin/review/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
type 否 1 1为入驻商待审核列表 2为合伙人待审核列表(默认为1) 3为股东审核列表
page 否 1
keyword 否 维维

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ statusstring非必须
├─ is_recommendstring非必须
├─ review_statusstring非必须
├─ review_remarkstring非必须
├─ review_timestring非必须
├─ realnamestring非必须
├─ wechatstring非必须
├─ mobilestring非必须
├─ mch_common_cat_idstring非必须
├─ transfer_ratestring非必须
├─ account_moneystring非必须
├─ sortstring非必须
├─ form_datastring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ storeobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ province_idstring非必须
├─ city_idstring非必须
├─ district_idstring非必须
├─ longitudestring非必须
├─ latitudestring非必须
├─ scorestring非必须
├─ cover_urlstring非必须
├─ pic_urlstring非必须
├─ business_hoursstring非必须
├─ descriptionstring非必须
├─ scopestring非必须
├─ is_defaultstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

获取审核消息tab栏

基本信息

Path: /api/admin/review/tabs

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ typeidnumber必须
├─ typestring必须

获取入驻商申请详情信息

基本信息

Path: /api/admin/review/detail

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
id 是 99 入驻商id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ statusstring非必须
├─ is_recommendstring非必须
├─ review_statusstring非必须
├─ review_remarkstring非必须
├─ review_timestring非必须
├─ realnamestring非必须
├─ wechatstring非必须
├─ mobilestring非必须
├─ mch_common_cat_idstring非必须
├─ transfer_ratestring非必须
├─ account_moneystring非必须
├─ sortstring非必须
├─ form_datastring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ mchUserobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ storeobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ province_idstring非必须
├─ city_idstring非必须
├─ district_idstring非必须
├─ longitudestring非必须
├─ latitudestring非必须
├─ scorestring非必须
├─ cover_urlstring非必须
├─ pic_urlstring非必须
├─ business_hoursstring非必须
├─ descriptionstring非必须
├─ scopestring非必须
├─ is_defaultstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ longitude_latitudestring非必须
├─ addressstring非必须
├─ logostring非必须
├─ service_mobilestring非必须
├─ bg_pic_urlobject非必须
├─ namestring非必须
├─ descriptionstring非必须
├─ scopestring非必须
├─ districtnumber []非必须

item 类型: number

├─ 非必须

入驻商/合伙人 审核通过/拒绝

基本信息

Path: /api/admin/review/switch-status

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
user_id 否 61 type为2时,必须
type 是 2 1为多商户 2为合伙人 3为股东(其他参数参考后台股东审核)
status 是 1为通过 0为拒绝

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

首页图表

基本信息

Path: /api/admin/data-statistics/table

Method: POST

接口描述:

同 数据统计-图表

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息

订单列表/订单消息

基本信息

Path: /api/admin/order/index

Method: POST

接口描述:

订单消息跳转到订单列表的时候,带订单号过去直接查询,并根据状态如下进行状态显示
is_pay = 0  未付款
is_pay = 1 或者 pay_type = 2  已付款



售后消息跳转到售后列表

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
status 否 -1全部 0未付款 1待发货 2待收货 3已完成 4待处理/待退款/退款提醒 5已取消 7 回收站 8下单提醒
store_id 否 门店id
date_start 是 开始时间 y-m-sH:i:s
date_end 是
clerk_id 是 核销员id
user_id 是 用户id
is_offline 是 是否到店自提:0.否
keyword 是
keyword_1 是 1 订单号搜索 2 昵称搜索 3名称搜索4订单id搜索5 商品搜索6收件人号码搜索
plugin 否 all all 全部订单

Body

参数名称 参数类型 是否必须 示例 备注
plugin text 是 all 插件标识 all全部

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ mch_idstring必须
├─ order_nostring必须
├─ total_pricestring必须
├─ total_pay_pricestring必须
├─ express_pricestring必须
├─ total_goods_pricestring必须
├─ total_goods_original_pricestring必须
├─ member_discount_pricestring必须
├─ use_user_coupon_idstring必须
├─ coupon_discount_pricestring必须
├─ use_integral_numstring必须
├─ integral_deduction_pricestring必须
├─ namestring必须
├─ mobilestring必须
├─ addressstring必须
├─ remarkstring必须
├─ order_formobject,null必须
├─ wordsstring必须
├─ seller_remarkstring必须
├─ is_paystring必须
├─ pay_typestring必须
├─ pay_timestring必须
├─ is_sendstring必须
├─ send_timestring必须
├─ expressstring必须
├─ express_nostring必须
├─ is_salestring必须
├─ is_confirmstring必须
├─ confirm_timestring必须
├─ cancel_statusstring必须
├─ cancel_timestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_recyclestring必须
├─ is_offlinestring必须
├─ offline_qrcodestring必须
├─ clerk_idstring必须
├─ store_idstring必须
├─ tokenstring必须
├─ nicknamestring必须用户昵称
├─ detailobject []必须订单详情信息(备注见order_detail)

item 类型: object

├─ idstring必须
├─ order_idstring必须
├─ goods_idstring必须
├─ numstring必须
├─ unit_pricestring必须
├─ total_original_pricestring必须
├─ total_pricestring必须
├─ member_discount_pricestring必须
├─ goods_infostring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ goodsobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ sortstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_levelstring非必须
├─ confine_countstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ is_negotiablestring非必须
├─ freight_idstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ refundnull必须商品售后情况
├─ attr_listobject []必须商品规格

item 类型: object

├─ attr_group_namestring必须规格组
├─ attr_group_idnumber,string必须
├─ attr_idnumber,string必须
├─ attr_namestring必须规格名
├─ clerkobject必须核销人信息
├─ field_2string必须
├─ storeobject必须门店信息
├─ exportListstring []非必须导出信息(未处理)

item 类型: string

├─ 非必须

修改总价格

基本信息

Path: /api/admin/order/update-total-price

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 订单ID
mch_id text 是
total_price text 是 价格
express_price text 是 运费

返回数据

名称类型是否必须默认值备注其他信息

修改收货信息

基本信息

Path: /api/admin/order/update-address

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 订单ID
name text 是 名字
mobile text 是 手机
province text 是 省
city text 是 市
district text 是 区
address text 是 详细地址

收货地址列表

基本信息

Path: /api/admin/order/address-list

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

查看物流

基本信息

Path: /api/order/express-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 否
express 是
express_no 是
customer_name 否 京东物流必填

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ orderobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ mch_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ express_original_pricestring非必须
├─ express_pricestring非必须
├─ total_goods_pricestring非必须
├─ total_goods_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ use_user_coupon_idstring非必须
├─ coupon_discount_pricestring非必须
├─ use_integral_numstring非必须
├─ integral_deduction_pricestring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ remarkstring非必须
├─ order_formstring非必须
├─ wordsstring非必须
├─ seller_remarkstring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_sendstring非必须
├─ send_timestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ is_salestring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ cancel_statusstring非必须
├─ cancel_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_recyclestring非必须
├─ is_offlinestring非必须
├─ offline_qrcodestring非必须
├─ clerk_idstring非必须
├─ store_idstring非必须
├─ signstring非必须
├─ tokenstring非必须
├─ support_pay_typesstring非必须
├─ is_commentstring非必须
├─ comment_timestring非必须
├─ sale_statusstring非必须
├─ statusstring非必须
├─ back_pricestring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infoobject非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ goods_attrobject非必须
├─ idnumber非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stocknumber非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ share_commission_firststring非必须
├─ share_commission_secondstring非必须
├─ share_commission_thirdstring非必须
├─ member_pricenull非必须
├─ integral_pricenull非必须
├─ use_integralnull非必须
├─ discountstring []非必须

item 类型: string

├─ 非必须
├─ extrastring []非必须

item 类型: string

├─ 非必须
├─ goods_warehouse_idnumber非必须
├─ namestring非必须
├─ cover_picstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_refundstring非必须
├─ refund_statusstring非必须
├─ back_pricestring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ expressobject非必须物流信息
├─ listobject []非必须

item 类型: object

├─ datetimestring非必须
├─ descstring非必须
├─ memonull非必须
├─ statusnumber非必须
├─ status_textstring非必须

取消订单

基本信息

Path: /api/admin/order/cancel

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 订单ID
mch_id text 是
status text 是 1 同意取消 2 拒绝
remark text 是 备注

返回数据

名称类型是否必须默认值备注其他信息

订单详情后台

基本信息

Path: /api/admin/order/detail

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
order_id 是 订单ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ orderobject非必须详见order表
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ mch_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ express_pricestring非必须
├─ total_goods_pricestring非必须
├─ total_goods_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ use_user_coupon_idstring非必须
├─ coupon_discount_pricestring非必须
├─ use_integral_numstring非必须
├─ integral_deduction_pricestring非必须
├─ namestring非必须收件人
├─ mobilestring非必须手机号码
├─ addressstring非必须地址
├─ remarkstring非必须
├─ wordsstring非必须商家留言
├─ seller_remarkstring非必须商家订单备注
├─ is_paystring非必须是否支付:0.未支付|1.已支付
├─ pay_typestring非必须
├─ pay_timestring非必须支付时间
├─ is_sendstring非必须
├─ send_timestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ is_salestring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ cancel_statusstring非必须
├─ cancel_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_recyclestring非必须
├─ is_offlinestring非必须
├─ offline_qrcodestring非必须
├─ clerk_idstring非必须
├─ store_idstring非必须
├─ tokenstring非必须
├─ userobject非必须用户信息
├─ idstring非必须
├─ mall_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infostring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlobject []非必须商品轮播图

item 类型: object

├─ idstring必须
├─ pic_urlstring必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ sortstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_levelstring非必须
├─ confine_countstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ is_negotiablestring非必须
├─ freight_idstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ refundobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ order_detail_idstring非必须
├─ order_nostring非必须
├─ typestring非必须
├─ refund_pricestring非必须
├─ remarkstring非必须
├─ pic_liststring非必须
├─ statusstring非必须
├─ status_timestring非必须
├─ refuse_remarkstring非必须
├─ is_sendstring非必须
├─ send_timestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ address_idstring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attr_listobject []非必须规格信息

item 类型: object

├─ attr_group_namestring必须规格组
├─ attr_group_idstring,number必须
├─ attr_idstring,number必须
├─ attr_namestring必须规格名
├─ refundstring非必须售后状态
├─ order_formstring []非必须订单form(未处理)

item 类型: string

├─ 非必须
├─ mchstring []非必须多商户(未处理)

item 类型: string

├─ 非必须

售后列表/订单消息-售后

基本信息

Path: /api/admin/order/refund

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
status 是 0 -1全部 0未处理/售后消息 1 已处理 2代发货 3待收货
user_id 是
date_start 是
date_end 是
keyword 是
keyword_1 是 1 订单号搜索 2 昵称搜索 3名称搜索4订单id搜索5 6收件人号码搜索

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须售后订单列表(详情见售后表)

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ order_idstring必须
├─ order_detail_idstring必须
├─ order_nostring必须
├─ typestring必须
├─ refund_pricestring必须
├─ remarkstring必须
├─ pic_liststring必须
├─ statusstring必须
├─ status_timestring必须
├─ merchant_remarkstring必须
├─ is_sendstring必须
├─ send_timestring必须
├─ expressstring必须
├─ express_nostring必须
├─ address_idstring必须
├─ is_confirmstring必须
├─ confirm_timestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ namestring必须收件人
├─ mobilestring必须电话号码
├─ addressstring必须地址
├─ pay_typestring必须支付方式
├─ detailobject必须订单详情
├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infostring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ sortstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_levelstring非必须
├─ confine_countstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ is_negotiablestring非必须
├─ freight_idstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ addressobject []非必须后台收货地址

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ mch_idnumber必须
├─ namestring必须
├─ addressstring必须
├─ mobilestring必须
├─ remarkstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ exportListstring []非必须

item 类型: string

├─ 非必须

售后处理

基本信息

Path: /api/admin/order/refund-handle

Method: POST

接口描述:

售后换货  无需物流 is_express=0  merchant_remark
                 需要物流 is_express=1 merchant_remark   express  express_no   merchant_remark

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_refund_id text 是
type text 是 1退货 2 换货
is_agree text 是 1同意 0拒绝 2取消售后
refund text 是 1退货 2退货退款
refund_price text 是 退货价格 为空表示原支付价
address_id text 是 地址ID
merchant_remark text 是 商家同意
express text 是 快递公司
express_no text 是 快递单号
is_express text 是 0无需物流 1需要

返回数据

名称类型是否必须默认值备注其他信息

新增商品

基本信息

Path: /api/admin/goods/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
form text 是 {"attr":[{"id":1383,"goods_id":1028,"sign_id":"2:5","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":2,"attr_name":"红色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":5,"attr_name":"小"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1384,"goods_id":1028,"sign_id":"3:5","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":3,"attr_name":"黄色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":5,"attr_name":"小"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1385,"goods_id":1028,"sign_id":"4:5","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":4,"attr_name":"绿色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":5,"attr_name":"小"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1386,"goods_id":1028,"sign_id":"2:6","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":2,"attr_name":"红色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":6,"attr_name":"中"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1387,"goods_id":1028,"sign_id":"3:6","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":3,"attr_name":"黄色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":6,"attr_name":"中"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1388,"goods_id":1028,"sign_id":"4:6","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":4,"attr_name":"绿色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":6,"attr_name":"中"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1389,"goods_id":1028,"sign_id":"2:7","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":2,"attr_name":"红色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":7,"attr_name":"大"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1390,"goods_id":1028,"sign_id":"3:7","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":3,"attr_name":"黄色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":7,"attr_name":"大"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1391,"goods_id":1028,"sign_id":"4:7","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":4,"attr_name":"绿色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":7,"attr_name":"大"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0}],"cats":[35,39,61],"mchCats":[],"cards":[],"services":[],"pic_url":[{"id":"546","pic_url":"http://v4test.zjhejiang.com/web/uploads/20190528/2247632a642b9924881d8715dd43b28e.gif"}],"use_attr":1,"goods_num":90,"status":1,"unit":"件","virtual_sales":555,"cover_pic":"http://v4test.zjhejiang.com/web/uploads/20190528/2247632a642b9924881d8715dd43b28e.gif","sort":100,"accumulative":0,"confine_count":-1,"forehead":"0.00","forehead_integral":0,"forehead_integral_type":1,"freight_id":0,"give_integral":0,"give_integral_type":1,"individual_share":0,"is_level":0,"is_level_alone":0,"pieces":0,"share_type":0,"attr_setting_type":0,"video_url":"","is_quick_shop":1,"is_sell_well":1,"is_negotiable":0,"share_commission_first":"0.00","share_commission_second":"0.00","share_commission_third":"0.00","name":"小鸡","price":"9.90","original_price":"5.00","cost_price":"2.00","detail":"

jjj

","extra":"","app_share_title":"","app_share_pic":"","is_default_services":1,"member_price":{},"goods_no":"","goods_weight":"","select_attr_groups":[],"goodsWarehouse_attrGroups":[],"mall_id":2,"created_at":"2019-05-28 15:11:14","updated_at":"2019-05-29 10:05:56","deleted_at":"2019-05-29 10:05:56","is_delete":0,"mch_id":0,"goods_warehouse_id":98,"attr_groups":[{"attr_group_id":1,"attr_group_name":"颜色","attr_list":[{"attr_id":2,"attr_name":"红色"},{"attr_id":3,"attr_name":"黄色"},{"attr_id":4,"attr_name":"绿色"}]},{"attr_group_id":2,"attr_group_name":"大小","attr_list":[{"attr_id":5,"attr_name":"小"},{"attr_id":6,"attr_name":"中"},{"attr_id":7,"attr_name":"大"}]}],"goods_stock":90,"sign":"","payment_people":0,"payment_num":0,"payment_amount":"0.00","payment_order":0,"goods_warehouse":{"goods_id":1028,"name":"小鸡","original_price":"5.00","attr_groups":[{"attr_group_id":1,"attr_group_name":"颜色","attr_list":[{"attr_id":2,"attr_name":"红色"},{"attr_id":3,"attr_name":"黄色"},{"attr_id":4,"attr_name":"绿色"}]},{"attr_group_id":2,"attr_group_name":"大小","attr_list":[{"attr_id":5,"attr_name":"小"},{"attr_id":6,"attr_name":"中"},{"attr_id":7,"attr_name":"大"}]}]},"id":"1028"}
商品分类:cats 【请求获取分类列表接口】

商品名称:name
商品详情:detail
商品缩略图:cover_pic
单位:unit
原价:original_price
成本价:cost_price
规格组与规格值:attr
积分赠送:give_integral
积分抵扣:forehead_integral
单品满减包邮:pieces
单品满额包邮:forehead
限购数量:confine_count
运费设置:freight_id
商品服务:services 【请求获取商品服务列表接口】
卡券:cards 【请求获取商品卡券列表接口】 |
| attrGroups | text | 是 | [{"attr_group_id":1,"attr_group_name":"颜色","attr_list":[{"attr_id":2,"attr_name":"红色"},{"attr_id":3,"attr_name":"黄色"},{"attr_id":4,"attr_name":"绿色"}]},{"attr_group_id":2,"attr_group_name":"大小","attr_list":[{"attr_id":5,"attr_name":"小"},{"attr_id":6,"attr_name":"中"},{"attr_id":7,"attr_name":"大"}]}] | |

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

获取商品服务列表

基本信息

Path: /api/admin/service/options

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ namestring必须
├─ is_defaultstring必须

获取商品卡券列表

基本信息

Path: /api/admin/card/options

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ namestring必须

获取商品分类列表

基本信息

Path: /api/admin/cat/options

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ valuestring必须
├─ labelstring必须
├─ childrenobject []必须

item 类型: object

├─ valuestring必须
├─ labelstring必须
├─ childrenobject []必须

item 类型: object

├─ valuestring必须
├─ labelstring必须

团队分红--插件

新增/编辑等级

基本信息

Path: /plugin/bonus/mall/members/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 否 1 等级id 有是修改,没有则新增
form[pic_url] text 是 http://v4test2.zjhejiang.com/web/uploads/mall120/20190730/af580a4eb005460a7fda2cd14616535d.jpg 等级图
form[bg_pic_url] text 是 http://v4test2.zjhejiang.com/web/uploads/mall120/20190730/af580a4eb005460a7fda2cd14616535d.jpg 等级背景图
form[level] text 是 1 等级 1~100
form[name] text 是 这是名称 等级名称
form[status] text 是 1 状态 1为开 0为关
form[auto_update] text 是 1 自动升级 1为开 0为关
form[rules] text 是

啦啦啦啦啦

等级规则
form[rate] text 是 5 分红比例
form[type] text 是 2 升级条件类型 0:累计佣金 1:已提现佣金 2:下级总人数 3:下级合伙人数 4:下级队长数
form[condition] text 是 500 升级条件

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

队长等级列表

基本信息

Path: /plugin/bonus/mall/members/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ levelstring非必须
├─ namestring非必须
├─ auto_updatestring非必须
├─ update_typestring非必须
├─ update_conditionstring非必须
├─ ratestring非必须
├─ statusstring非必须
├─ pic_urlstring非必须
├─ rulesstring非必须
├─ bg_pic_urlstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

前端发起提现

基本信息

Path: /plugin/bonus/api/index/cash

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
price text 是 100 提现金额
type text 是 auto 提现类型

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

前端获取团队分红设置

基本信息

Path: /plugin/bonus/api/index/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息

可用等级列表

基本信息

Path: /plugin/bonus/mall/members/options

Method: GET

接口描述:

disabled:true 则代表已经使用,不可选

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须
├─ levelnumber必须
├─ disabledboolean必须

后台删除被拒绝的队长审核

基本信息

Path: /plugin/bonus/mall/captain/delete

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
user_id text 是 259

后台备注提现申请

基本信息

Path: /plugin/bonus/mall/cash/remark

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
remark text 是 这是一条备注
id text 是 1 提现id

返回数据

名称类型是否必须默认值备注其他信息

后台审核打款拒绝提现

基本信息

Path: /plugin/bonus/mall/cash/cash-apply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 1 提现id
status 是 1 1为审核通过 2为打款 3为拒绝
content 否 这是一条备注 status=3 时,必填

返回数据

名称类型是否必须默认值备注其他信息

后台提现列表

基本信息

Path: /plugin/bonus/mall/cash/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 1 -1 为所有 0--申请 1--同意 2--已打款 3--驳回
date_start 是 2019-07-01 14 开始时间
date_end 是 2019-07-18 14 结束时间
keyword 是 259 关键词
search_type 是 4 与keyword共用, 1为搜索队长昵称 2队长姓名 3队长手机 4用户id

返回数据

名称类型是否必须默认值备注其他信息
listobject []非必须

item 类型: object

├─ idnumber非必须
├─ order_nostring非必须
├─ pay_typestring非必须
├─ typestring非必须
├─ statusnumber非必须
├─ status_textstring非必须
├─ userobject非必须
├─ avatarstring非必须
├─ nicknamestring非必须
├─ platformstring非必须
├─ cashobject非必须
├─ pricenumber非必须
├─ service_chargenumber非必须
├─ actual_pricenumber非必须
├─ extraobject非必须
├─ namestring非必须
├─ mobilestring非必须
├─ bank_namestring非必须
├─ timeobject非必须
├─ created_atstring非必须
├─ apply_atstring非必须
├─ remittance_atstring非必须
├─ reject_atstring非必须
├─ contentobject非必须
├─ apply_contentstring非必须
├─ remittance_contentstring非必须
├─ reject_contentstring非必须
paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
export_listobject []非必须

item 类型: object

├─ keystring必须
├─ valuestring必须

后台解除队长

基本信息

Path: /plugin/bonus/mall/captain/remove

Method: POST

接口描述:

返回一个队列id

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
user_id text 是 280 用户id
reason text 是 I like 解除原因

返回数据

名称类型是否必须默认值备注其他信息

后台队长列表

基本信息

Path: /plugin/bonus/mall/captain/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 否 1 1通过 0审核中 2拒绝 3处理中
date_start 否 2019-07-01 14 开始时间
date_end 否 2019-07-18 14 结束时间
keyword 否 259 关键字
search_type 否 4 1为搜索队长昵称 2队长姓名 3队长手机 4用户id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ namestring必须
├─ mobilestring必须
├─ user_idnumber必须
├─ total_bonusstring必须
├─ cash_bonusstring必须
├─ expect_bonusstring必须
├─ reasonstring必须
├─ remarkstring必须
├─ statusnumber必须
├─ all_membernumber必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ apply_atstring,null必须
├─ is_deletenumber必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ export_listobject []非必须

item 类型: object

├─ keystring必须
├─ valuestring必须

后台队长备注

基本信息

Path: /plugin/bonus/mall/captain/remark

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
user_id text 是 259
remark text 是 备注

后台队长审核

基本信息

Path: /plugin/bonus/mall/captain/apply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
user_id text 是 259
status text 是 1 1通过 2拒绝
reason text 是 原因 拒绝时必填,同意是填个“后台管理员审核通过”

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
datanumber非必须队列id

获取等级

基本信息

Path: /plugin/bonus/mall/members/edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 等级id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ levelnumber非必须
├─ namestring非必须
├─ auto_updatestring非必须
├─ update_typestring非必须
├─ update_conditionstring非必须
├─ ratestring非必须
├─ statusstring非必须
├─ pic_urlstring非必须
├─ rulesstring非必须
├─ bg_pic_urlstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须

团队分红设置

基本信息

Path: /plugin/bonus/mall/setting/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
is_bonus text 是 1 1为开启 0为关闭
bonus_rate text 是 5
become_type text 是 1 1佣金总额 2已提现佣金总额 3下线认数 4下线合伙人数
condition text 是 500 条件
is_agreement text 是 1
agreement_title text 是 哈哈
agreement_content text 是 安德森高大上a
pay_type[0] text 是 alipay
min_money text 是 1
cash_service_charge text 是 5
free_cash_min text 是 1
free_cash_max text 是 100
form[entry_bonus] text 是 哈哈
form[title] text 是 阿斯顿
form[count] text 是 5
form[shares] text 是 2
form[total_bonus] text 是
form[expect_bonus] text 是
form[cashd_bonus] text 是
form[can_cash_bonus] text 是
form[statistic_bonus] text 是
form[statistic_total] text 是
form[statistic_today] text 是
form[statistic_seven_days] text 是
form[statistic_one_month] text 是
form[orders] text 是
form[members] text 是

返回数据

名称类型是否必须默认值备注其他信息

分红订单/订单列表相关

基本信息

Path: /plugin/bonus/mall/order/index

Method: POST

接口描述:

出参参考http://106.14.190.102:3000/project/25/interface/api/609
新参数      "captain_name": "张大师",                    队长名
                "captain_mobile": "18899990000",        队长电话
                "bonus_price": "140000.00",                 分红金额
                "bonus_status": "1",                              分红状态  0预计分红,1完成分红,2分红失败

小程序端接口 /plugin/bonus/api/order/index

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
status text 否 1未完成,2已完成
keyword text 否 搜索词
keyword_1 text 否 1订单号,2昵称,3收件人,4用户ID,5商品名,6收货手机,7队长名
page text 否 页码get传值
limit text 否 每页数量
date_start text 否 开始时间
date_end text 否 结束时间
is_offline text 是 1自提,2快递

返回数据

名称类型是否必须默认值备注其他信息

查看审核状态

基本信息

Path: /plugin/bonus/api/index/apply-status

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ captainobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ namestring非必须
├─ mobilestring非必须
├─ user_idnumber非必须
├─ total_bonusstring非必须
├─ cash_bonusstring非必须
├─ expect_bonusstring非必须
├─ reasonstring非必须
├─ remarkstring非必须
├─ statusnumber非必须0为申请中 1为审核通过 2为拒绝 3为审核处理中
├─ all_membernumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ apply_atstring非必须
├─ is_deletenumber非必须

查看是否符合申请要求

基本信息

Path: /plugin/bonus/api/index/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token 是 dhL-sV6nhteKmaV-Z72Nc02B2_Qz0Y_H

Query

参数名称 是否必须 示例 备注
_mall_id 是 120

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ total_moneystring非必须后台配置的项
├─ passboolean非必须是否符合条件
├─ conditionnumber非必须条件

查询解除队长队列执行状态

基本信息

Path: /plugin/bonus/mall/captain/remove-status

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
queue_id 是 101046 队列id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
datastring非必须

查询队长审核队列执行状态

基本信息

Path: /plugin/bonus/mall/captain/apply-status

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
queue_id 是 101046 队列id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
datastring非必须

清除申请状态

基本信息

Path: /plugin/bonus/api/index/clear-apply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息

申请队长

基本信息

Path: /plugin/bonus/api/index/apply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token dhL-sV6nhteKmaV-Z72Nc02B2_Qz0Y_H 是

Query

参数名称 是否必须 示例 备注
_mall_id 是 120

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 张三 姓名
mobile text 是 13232323232 手机
is_agree text 是 1 是否勾选协议 (如果后台设置关闭协议,前端默认帮用户填1)

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

禁用或恢复

基本信息

Path: /plugin/bonus/mall/members/switch-status

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

移除等级

基本信息

Path: /plugin/bonus/mall/members/destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

获取团队分红设置

基本信息

Path: /plugin/bonus/mall/setting/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject非必须
├─ is_bonusnumber非必须
├─ bonus_ratenumber非必须
├─ become_typenumber非必须
├─ conditionnumber非必须
├─ is_agreementnumber非必须
├─ agreement_titlestring非必须
├─ agreement_contentstring非必须
├─ pay_typestring []非必须

item 类型: string

├─ 非必须
├─ min_moneynumber非必须
├─ cash_service_chargenumber非必须
├─ free_cash_minnumber非必须
├─ free_cash_maxnumber非必须
├─ bg_urlstring非必须
├─ formobject非必须
├─ entry_bonusstring非必须
├─ titlestring非必须
├─ countstring非必须
├─ sharesstring非必须
├─ total_bonusstring非必须
├─ expect_bonusstring非必须
├─ cashd_bonusstring非必须
├─ can_cash_bonusstring非必须
├─ statistic_bonusstring非必须
├─ statistic_totalstring非必须
├─ statistic_todaystring非必须
├─ statistic_seven_daysstring非必须
├─ statistic_one_monthstring非必须
├─ ordersstring非必须
├─ membersstring非必须

获取所有等级

基本信息

Path: /plugin/bonus/mall/members/all-member

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ levelnumber必须
├─ namestring必须
├─ auto_updatenumber必须
├─ update_typenumber必须
├─ update_conditionstring必须
├─ ratestring必须
├─ statusnumber必须
├─ pic_urlstring必须
├─ rulesstring必须
├─ bg_pic_urlstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须

订单详情

基本信息

Path: /plugin/bonus/mall/order/detail

Method: POST

接口描述:

出参参考http://106.14.190.102:3000/project/25/interface/api/577
新参数      "captain_name": "张大师",                    队长名
                "captain_mobile": "18899990000",        队长电话
                "bonus_price": "140000.00",                 分红金额
                "bonus_status": "1",                              分红状态  0预计分红,1完成分红,2分红失败

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是

返回数据

名称类型是否必须默认值备注其他信息

订单备注

基本信息

Path: /plugin/bonus/mall/order/remark

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是
remark text 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

团员列表

基本信息

Path: /plugin/bonus/mall/order/team-bonus

Method: POST

接口描述:

小程序端接口 /plugin/bonus/api/order/team-bonus

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
captain_id text 是 队长ID
keyword_1 text 否 1昵称,2手机号,3用户ID
keyword text 否 搜索词
order_by text 否 bonus_price desc / bonus_price 排序

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ captainobject非必须队长资料
├─ user_idstring非必须
├─ namestring非必须名字
├─ mobilestring非必须手机
├─ all_memberstring非必须队员数量
├─ nicknamestring非必须昵称
├─ avatarstring非必须头像
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ bonus_pricestring非必须分红金额
├─ user_idstring非必须用户ID
├─ nicknamestring非必须昵称
├─ mobilestring非必须手机
├─ avatarstring非必须头像
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

分红统计

基本信息

Path: /plugin/bonus/api/order/data

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ all_dataobject非必须总览数据
├─ day_datanull非必须昨日
├─ day_7_datastring非必须7日
├─ month_12_datastring非必须12月
├─ listobject非必须数据列表
├─ day_listobject []非必须昨日24小时

item 类型: object

├─ created_atnumber必须
├─ bonus_pricestring必须
├─ day_7_listobject []非必须7日

item 类型: object

├─ created_atstring必须
├─ bonus_pricestring必须
├─ month_12_listobject []非必须12月

item 类型: object

├─ created_atstring必须
├─ bonus_pricestring必须

手机核销

核销订单列表

基本信息

Path: /plugin/clerk/api/index/order

Method: GET

接口描述:

出参参考http://106.14.190.102:3000/project/25/interface/api/609

请求参数

Query

参数名称 是否必须 示例 备注
is_clerk 是 1、已核销 2、未核销
keyword_1 是 1、订单号查询
keyword 是 查询字段

返回数据

名称类型是否必须默认值备注其他信息

我的核销订单列表

基本信息

Path: /plugin/clerk/api/index/my-order

Method: GET

接口描述:

出参参考http://106.14.190.102:3000/project/25/interface/api/609

请求参数

返回数据

名称类型是否必须默认值备注其他信息

订单详情

基本信息

Path: /plugin/clerk/api/index/detail

Method: GET

接口描述:

出参参考http://106.14.190.102:3000/project/25/interface/api/577

请求参数

Query

参数名称 是否必须 示例 备注
order_id 是

订单核销

基本信息

Path: /plugin/clerk/api/index/order-clerk

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是
clerk_remark text 是 备注

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

核销卡卷列表

基本信息

Path: /plugin/clerk/api/index/card

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
is_clerk 是 1、已核销 2、未核销

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须卡卷名
├─ pic_urlstring必须卡卷图
├─ user_idstring必须
├─ store_idstring必须
├─ store_namestring必须店铺名
├─ nicknamestring必须用户昵称
├─ platformstring必须所属APP
├─ is_usestring必须1核销 0未

我的核销卡卷列表

基本信息

Path: /plugin/clerk/api/index/my-card

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须卡卷名
├─ pic_urlstring必须卡卷图
├─ user_idstring必须
├─ store_idstring必须
├─ store_namestring必须店铺名
├─ nicknamestring必须用户昵称
├─ platformstring必须所属APP

卡券详情

基本信息

Path: /card/user-card-detail_1563844552351

Method: GET

接口描述:

接口/card/user-card-detail

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
cardId 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ cardobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ card_idstring非必须
├─ namestring非必须卡券名称
├─ pic_urlstring非必须卡券图片
├─ contentstring非必须卡券内容
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ is_usestring非必须是否使用 0--未使用|1--已使用
├─ clerk_idstring非必须核销员ID
├─ store_idstring非必须核销门店ID
├─ clerked_atstring非必须核销时间
├─ order_idstring非必须
├─ goods_idstring非必须
├─ datastring非必须
├─ clerknull非必须核销员信息
├─ storenull非必须核销门店信息

卡券核销

基本信息

Path: /card/card-clerk_1563844558055

Method: GET

接口描述:

接口/card/card-clerk

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
cardId 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

核销统计

基本信息

Path: /plugin/clerk/api/index/statistics

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
key 是 0累计 1今日 -1昨日 7七日 30三十日,默认是累计数据

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ order_num_listobject []非必须

item 类型: object

├─ timestring必须
├─ numstring必须
├─ order_price_listobject []非必须

item 类型: object

├─ timestring必须
├─ numstring必须
├─ card_listobject []非必须

item 类型: object

├─ timestring必须
├─ numstring必须

是否是平台核销员

基本信息

Path: /plugin/clerk/api/index/clerk-info

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ is_mallstring非必须true|false

扫码买单后台

买单设置优惠券列表

基本信息

Path: /scan_code_pay/mall/activity/coupons

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
page 是 1 分页
keyword 是 名称 优惠券名称搜索

返回数据

名称类型是否必须默认值备注其他信息

买单设置会员列表

基本信息

Path: /scan_code_pay/mall/activity/members

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
page 是 1 分页
keyword 是 名称 会员名称搜索

返回数据

名称类型是否必须默认值备注其他信息

买单设置列表

基本信息

Path: /scan_code_pay/mall/activity/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 分页
keyword 是 名称 名称

返回数据

名称类型是否必须默认值备注其他信息

买单设置删除

基本信息

Path: /scan_code_pay/mall/activity/destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
page 是 1 分布
keyword 是 名称 名称

Body

参数名称 参数类型 是否必须 示例 备注
activity_id text 是 1 活动ID

返回数据

名称类型是否必须默认值备注其他信息

买单设置卡券列表

基本信息

Path: /scan_code_pay/mall/activity/cards

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
page 是 1 分页
keyword 是 名称 卡券名称搜索

返回数据

名称类型是否必须默认值备注其他信息

买单设置新增|更新

基本信息

Path: /scan_code_pay/mall/activity/edit

Method: POST

接口描述:

{
    name: '测试',
    start_time: '2019-07-31 13:40:00',
    end_time: '2019-08-31 13:40:00',
    send_type: 1,
    rules: '',
    status: 1,
    groups: JSON.stringify([
        {
            name: '组1',
            members: [
                {
                    name: '等级1',
                    level: 1,
                },
            ],
            rules: [
                {
                    rules_type: 1,
                    consume_money: 300,
                    send_integral_num: 10,
                    integral_type: 1,
                    send_money: 10.12,
                    preferential_money: 20,
                    integral_deduction: 0,
                    integral_deduction_type: 1,
                    is_coupon: 1,
                    cards: [
                        {
                            send_num: 1,
                            card_id: 28,
                        },
                        {
                            send_num: 2,
                            card_id: 31,
                        }
                    ],
                    coupons: [
                        {
                            send_num: 1,
                            coupon_id: 155,
                        },
                        {
                            send_num: 2,
                            coupon_id: 154,
                        },
                    ]
                },
                {
                    rules_type: 1,
                    consume_money: 400,
                    send_integral_num: 10,
                    integral_type: 1,
                    send_money: 10.12,
                    preferential_money: 20,
                    integral_deduction: 0,
                    integral_deduction_type: 1,
                    is_coupon: 1,
                    cards: [
                        {
                            send_num: 1,
                            card_id: 28,
                        },
                        {
                            send_num: 3,
                            card_id: 31,
                        }
                    ],
                    coupons: [
                        {
                            send_num: 1,
                            coupon_id: 155,
                        },
                        {
                            send_num: 2,
                            coupon_id: 154,
                        },
                    ]
                },
            ]
        },
        {
            name: '组2',
            members: [
                {
                    name: '等级2',
                    level: 2,
                },
            ],
            rules: [
                {
                    rules_type: 1,
                    consume_money: 500,
                    send_integral_num: 10,
                    integral_type: 1,
                    send_money: 10.12,
                    preferential_money: 20,
                    integral_deduction: 0,
                    integral_deduction_type: 1,
                    is_coupon: 1,
                    cards: [
                        {
                            send_num: 1,
                            card_id: 31,
                        },
                        {
                            send_num: 2,
                            card_id: 35,
                        }
                    ],
                    coupons: [
                        {
                            send_num: 1,
                            coupon_id: 155,
                        },
                        {
                            send_num: 2,
                            coupon_id: 154,
                        },
                    ]
                },
                {
                    rules_type: 1,
                    consume_money: 600,
                    send_integral_num: 10,
                    integral_type: 1,
                    send_money: 10.12,
                    preferential_money: 20,
                    integral_deduction: 0,
                    integral_deduction_type: 1,
                    is_coupon: 1,
                    cards: [
                        {
                            send_num: 1,
                            card_id: 28,
                        },
                        {
                            send_num: 2,
                            card_id: 31,
                        }
                    ],
                    coupons: [
                        {
                            send_num: 1,
                            coupon_id: 155,
                        },
                        {
                            send_num: 2,
                            coupon_id: 154,
                        },
                    ]
                },
            ]
        },
    ])
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
activity_id 是 1 活动ID

Body

参数名称 参数类型 是否必须 示例 备注
id text 否 1 更新时操作时 再传
name text 是 活动设置名称 活动设置名称
start_time text 是 2019-08-10 18:30:30 开始时间
end_time text 是 2019-08-10 18:30:30 结束时间
send_type text 是 1 活动类型 1.赠送所有规则
status text 是 1 0.关闭
rules text 是 哈哈哈 规则
groups text 是 json json格式 具体数据格式看最下面备注

返回数据

名称类型是否必须默认值备注其他信息

买单设置更新状态

基本信息

Path: /scan_code_pay/mall/activity/switch-status

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
activity_id 是 1 活动ID

Body

参数名称 参数类型 是否必须 示例 备注
activity_id text 是 1 活动ID
status text 是 1 状态 0.状态

返回数据

名称类型是否必须默认值备注其他信息

买单设置详情

基本信息

Path: /scan_code_pay/mall/activity/edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
activity_id 是 1 活动ID

返回数据

名称类型是否必须默认值备注其他信息

扫码买单小程序端

扫码买单 取消订单

基本信息

Path: /plugin/scan_code_pay/api/order/cancel

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 1 订单ID

返回数据

名称类型是否必须默认值备注其他信息

扫码买单下单

基本信息

Path: /plugin/scan_code_pay/api/order/submit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
price text 是 10 输入金额
coupon_id text 是 0 未选择优惠券填写0
use_integral text 是 1 是否使用积分抵扣0.否
remark text 是 1 备注信息

扫码买单二维码

基本信息

Path: /plugin/scan_code_pay/api/index/qr-code

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
price text 否 10.12 输入金额

扫码买单优惠券

基本信息

Path: /plugin/scan_code_pay/api/order/coupons

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
price text 是 10.12 输入金额

返回数据

名称类型是否必须默认值备注其他信息

扫码买单预览

基本信息

Path: /plugin/scan_code_pay/api/order/preview

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
price text 是 10 输入金额
coupon_id text 是 0 未选择优惠券填写0
use_integral text 是 1 是否使用积分抵扣0.否

返回数据

名称类型是否必须默认值备注其他信息

扫码买单首页

基本信息

Path: /plugin/scan_code_pay/api/index/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ activityobject非必须活动信息
├─ idnumber非必须活动ID
├─ mall_idnumber非必须商城ID
├─ namestring非必须活动名称
├─ start_timestring非必须活动开始时间
├─ end_timestring非必须活动结束时间
├─ send_typenumber非必须1.赠送所有规则|2.赠送满足最高规则
├─ rulesstring非必须买单规则
├─ statusnumber非必须是否启用0.否|1.是
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ integralobject非必须
├─ member_integralstring非必须可抵扣积分
├─ member_integral_rulestring非必须积分使用规则
├─ user_integral_numnumber非必须用户积分余额
├─ goodsobject非必须
├─ idstring非必须商品ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ goods_warehouse_idstring非必须关联商品库ID
├─ statusstring非必须上架状态:0=下架,1=上架
├─ pricestring非必须售价
├─ use_attrstring非必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring非必须商品规格组
├─ goods_stockstring非必须商品总库存(规格库存相加)
├─ virtual_salesstring非必须已出售量(虚拟销量)
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模板ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否单独设置会员价
├─ share_typestring非必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring非必须商品标示用于区分商品属于什么模块
├─ app_share_picstring非必须商品自定义分享图片
├─ app_share_titlestring非必须商品自定义分享标题
├─ is_default_servicesstring非必须默认服务 0.否|1.是
├─ sortstring非必须商品排序
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须统计 支付人数
├─ payment_numstring非必须统计 支付件数
├─ payment_amountstring非必须统计 支付金额
├─ payment_orderstring非必须支付订单数
├─ confine_order_countstring非必须限制下单数量
├─ is_area_limitstring非必须是否单独区域购买
├─ area_limitstring非必须区域限制详情 json格式
├─ share_level_typestring非必须合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_idstring非必须自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ cover_picstring非必须商品缩略图
├─ unitstring非必须商品单位
├─ detailstring非必须商品详情
├─ video_urlstring非必须商品视频
├─ level_shownumber非必须会员等级是否显示0.否|1.是
├─ is_salesnumber非必须是否售后
├─ attrobject []非必须

item 类型: object

├─ idnumber非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stocknumber非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ is_deletenumber非必须
├─ settingobject非必须
├─ idnumber非必须设置ID
├─ mall_idnumber非必须商城ID
├─ is_scan_code_paynumber非必须是否开启扫码买单
├─ payment_typestring []非必须支付方式online_pay 线上支付 |balance 余额支付|huodao 货到付款

item 类型: string

├─ 非必须
├─ is_sharenumber非必须是否开启合伙人0.否|1.是
├─ is_smsnumber非必须是否开启短信提醒0.否|1.是
├─ is_mailnumber非必须是否开启邮件提醒0.否|1.是
├─ share_typenumber非必须合伙人类型 1.百分比|2.固定金额
├─ share_commission_firststring非必须一级合伙人金额
├─ share_commission_secondstring非必须二级合伙人金额
├─ share_commission_thirdstring非必须三级合伙人金额
├─ posterobject非必须自定义海报
├─ bg_picobject非必须背景图
├─ urlstring非必须背景图url
├─ is_shownumber非必须是否显示0.否|1.是
├─ qr_codeobject非必须二维码
├─ is_shownumber非必须是否显示0.否|1.是
├─ sizenumber非必须大小
├─ topnumber非必须距顶部距离
├─ leftnumber非必须距左侧距离
├─ typenumber非必须类型
├─ file_typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须

同城配送

后台设置

基本信息

Path: /mall/delivery/index

Method: POST

接口描述:

参数json对象值可根据前端需要更改

'is_open' => 0,//开关 1开0关
'is_superposition' => 0,//是否叠加 1叠加0不
'mobile' => '{{"name":"","mobile":""},{"name":"","mobile":""}}',
'price_mode' => '{"start_price":"0","start_distance":"0","add_distance":"0","add_price":"0","exceed":"0","fixed":"0"}',//计费方式
'web_key' => '',//高德key
'address' => '{"address":"","longitude":"","latitude":""}',//配送起点地址
'explain' => '',//配送说明(配送时间什么的)
'range'=>'{}'//经纬度划定范围

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ is_openstring非必须0关1开
├─ is_superpositionstring非必须0关1开
├─ is_expressstring非必须0关1开
├─ mobilestring非必须json对象
├─ price_modestring非必须json对象
├─ web_keystring非必须高德key

编辑保存

基本信息

Path: /mall/delivery/edit

Method: POST

接口描述:

数据保存时的格式,决定查询返回数据格式

set_data[is_open]:1
set_data[is_superposition]:1
set_data[mobile]:{{"name":"水电费","mobile":"18877774444"},{"name":"互联网","mobile":"18857574747"}}
set_data[price_mode]:{"start_price":"0","start_distance":"0","add_distance":"0","add_price":"0","exceed":"0","fixed":"0"}
set_data[web_key]:adfadfafsdasdf
set_data[address]:{"address":"阿里山","longitude":"90.1274","latitude":"32.33"}
set_data[explain]:周六不送
set_data[range]:{}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
set_data text 是 看备注👆

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

获取配送费

基本信息

Path: /api/express/delivery-price

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
distance 是 距离
num 是 商品数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pricenumber非必须

配送员信息

基本信息

Path: /mall/delivery/mobile

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ mobilestring非必须

超级会员卡--插件

会员卡下单

基本信息

Path: /plugin/vip_card/api/order/submit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 21 子卡id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ pay_idnumber非必须

我的会员卡信息

基本信息

Path: /plugin/vip_card/api/index/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token 是 dhL-sV6nhteKmaV-Z72Nc02B2_Qz0Y_H

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ userobject非必须
├─ idstring非必须
├─ mall_idstring非必须商城id
├─ user_idstring非必须用户id
├─ main_idstring非必须主卡id
├─ detail_idstring非必须子卡id
├─ image_typestring非必须购买时的类型 0:指定商品类别 1:指定商品 2:全场通用
├─ image_type_infoobject非必须购买时的类型详情
├─ goodsstring []非必须

item 类型: string

├─ 非必须
├─ catsstring []非必须

item 类型: string

├─ 非必须
├─ allboolean非必须
├─ image_discountstring非必须购买时的折扣
├─ image_is_free_deliverystring非必须购买时是否包邮
├─ image_main_namestring非必须购买时的主卡名称
├─ image_namestring非必须购买时的子卡名称
├─ all_sendstring非必须最后一次赠送记录
├─ datanull非必须
├─ start_timestring非必须会员卡开始时间
├─ end_timestring非必须会员卡结束时间
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ orderobject []非必须购买记录

item 类型: object

├─ created_atstring非必须
├─ expirestring非必须有效期
├─ detail_namestring非必须子卡名称
├─ user_idstring非必须用户id
├─ detail_idstring非必须子卡id
├─ expirenumber非必须有效天数
├─ image_type_info_detailobject非必须
├─ catsstring []非必须

item 类型: string

├─ 非必须
├─ allboolean非必须

新的主卡权益接口

基本信息

Path: /plugin/vip_card/api/index/index-right

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber必须
msgstring必须
dataobject必须
├─ rightobject非必须
├─ namestring非必须主卡名
├─ coverstring非必须主卡封面
├─ type_infoobject非必须
├─ goodsnumber []非必须指定商品id列表

item 类型: number

├─ 非必须
├─ catsstring []非必须指定商品分类id列表

item 类型: string

├─ 非必须
├─ allboolean非必须
├─ image_type_info_detailobject非必须
├─ goodsobject []非必须指定商品列表详情

item 类型: object

├─ namestring必须商品名
├─ idnumber必须商品id
├─ salesstring必须商品出售量
├─ pricestring必须商品价格
├─ cover_picstring必须商品封面
├─ page_urlstring必须跳转url
├─ catsobject []非必须指定商品分类列表详情

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ parent_idstring必须
├─ namestring必须
├─ pic_urlstring必须
├─ sortstring必须
├─ big_pic_urlstring必须
├─ advert_picstring必须
├─ advert_urlstring必须
├─ statusstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_showstring必须
├─ advert_open_typestring必须
├─ advert_paramsstring必须
├─ valuestring必须
├─ labelstring必须

获取会员卡

基本信息

Path: /plugin/vip_card/api/index/card

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ idstring非必须
├─ mall_idstring非必须商城id
├─ namestring非必须会员卡名称
├─ coverstring非必须会员卡封面
├─ typestring非必须0:指定商品类别 1:指定商品 2:全场通用
├─ type_infoobject非必须all为1则 全场通用,goods为指定商品,cats为指定分类
├─ goodsstring []非必须

item 类型: string

├─ 非必须
├─ catsstring []非必须

item 类型: string

├─ 非必须
├─ allboolean非必须
├─ discountstring非必须折扣
├─ is_discountstring非必须是否享受折扣
├─ is_free_deliverystring非必须是否全场包邮
├─ statusstring非必须默认 0
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ detailobject []非必须子卡详情

item 类型: object

├─ idstring非必须子卡id
├─ mall_idstring非必须商城id
├─ vip_idstring非必须主卡id
├─ namestring非必须子卡名称
├─ coverstring非必须子卡卡面
├─ expire_daystring非必须子卡有效期
├─ pricestring非必须子卡价格
├─ numstring非必须子卡数量
├─ sortstring非必须排序
├─ send_integral_numstring非必须赠送积分
├─ send_integral_typestring非必须赠送积分类型 默认为固定值
├─ send_balancestring非必须赠送余额
├─ titlestring非必须使用说明
├─ contentstring非必须内容
├─ statusstring非必须状态默认为1
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ cardsstring []非必须赠送卡券

item 类型: string

├─ 非必须
├─ vipCardsstring []非必须赠送卡券关联数据

item 类型: string

├─ 非必须
├─ couponsstring []非必须赠送优惠券

item 类型: string

├─ 非必须
├─ vipCouponsstring []非必须赠送优惠券关联数据

item 类型: string

├─ 非必须
├─ type_info_detailobject非必须
├─ goodsstring []非必须

item 类型: string

├─ 非必须
├─ catsstring []非必须

item 类型: string

├─ 非必须
├─ allboolean非必须

获取会员卡设置

基本信息

Path: /plugin/vip_card/api/index/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber必须
dataobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须商城id
├─ is_vip_cardnumber非必须SVIP会员卡开关
├─ payment_typestring []非必须支付类型

item 类型: string

├─ 非必须
├─ is_sharenumber非必须是否开启合伙人 0关闭 1开启
├─ is_smsnumber非必须是否开启短信 0关闭 1开启
├─ is_mailnumber非必须是否开启邮件 0关闭 1开启
├─ is_agreementnumber非必须是否显示协议 0关闭 1开启
├─ agreement_titlestring非必须协议名称
├─ agreement_contentstring非必须协议内容
├─ is_buy_become_sharenumber非必须购买成为合伙人 0关闭 1开启
├─ share_typenumber非必须合伙人佣金类型 0百分比 1固定金额
├─ share_commission_firststring非必须一级合伙人比例
├─ share_commission_secondstring非必须二级合伙人比例
├─ share_commission_thirdstring非必须三级合伙人比例
├─ formobject非必须自定义表单
├─ buy_big_colorstring非必须未购买用户大标题颜色
├─ buy_small_colorstring非必须未购买用户小标题颜色
├─ buy_btn_colorstring非必须未购买用户按钮颜色
├─ buy_btn_bg_colorstring非必须未购买用户按钮背景颜色
├─ buy_bigstring非必须为购买用户大标题
├─ buy_smallstring非必须为购买用户小标题
├─ buy_btn_textstring非必须未购买用户按钮文字
├─ renew_text_colorstring非必须已购买用户文字颜色
├─ renew_btn_bg_colorstring非必须已购买用户按钮背景颜色
├─ renew_textstring非必须已购买用户文字
├─ card_bgstring非必须卡面背景图
├─ card_colorstring非必须卡面颜色
├─ vip_bgstring非必须
├─ vip_colorstring非必须
├─ vip_numbernumber非必须
├─ vip_linenumber非必须
├─ is_vip_scrollnumber非必须
├─ vip_icon_listarray []非必须

item 类型: array

├─ 非必须
├─ 非必须
├─ right_listobject []非必须

item 类型: object

├─ imgstring非必须
├─ bigstring非必须
├─ big_colorstring非必须
├─ smallstring非必须
├─ small_colorstring非必须
├─ rubikobject非必须
├─ heightnumber非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ bottom_style_1string非必须
├─ bottom_style_2string非必须
├─ bottom_btn_style_1string非必须
├─ bottom_btn_style_2string非必须
├─ sortstring []非必须

item 类型: string

├─ 非必须
├─ head_cardstring非必须
├─ buy_bgstring非必须
├─ renew_bgstring非必须
├─ integral_iconstring非必须
├─ card_iconstring非必须
├─ coupon_iconstring非必须
├─ balance_iconstring非必须
├─ is_smsnumber非必须
├─ rulesstring []非必须规则

item 类型: string

├─ 非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ namestring非必须会员卡名称
msgstring非必须

获取子卡详情

基本信息

Path: /plugin/vip_card/api/index/card-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 21 子卡id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ vip_idstring非必须
├─ namestring非必须
├─ expire_daystring非必须
├─ pricestring非必须
├─ numstring非必须
├─ send_integral_numstring非必须
├─ send_integral_typestring非必须
├─ send_balancestring非必须
├─ titlestring非必须
├─ contentstring非必须
├─ statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ cardsobject []非必须

item 类型: object

├─ idstring非必须
├─ detail_idstring非必须
├─ card_idstring非必须
├─ send_numstring非必须
├─ is_deletestring非必须
├─ vipCardsobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pic_urlstring非必须
├─ descriptionstring非必须
├─ expire_typestring非必须
├─ expire_daystring非必须
├─ begin_timestring非必须
├─ end_timestring非必须
├─ total_countstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ couponsobject []非必须

item 类型: object

├─ idstring非必须
├─ detail_idstring非必须
├─ coupon_idstring非必须
├─ send_numstring非必须
├─ is_deletestring非必须
├─ vipCouponsobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ typestring非必须
├─ discountstring非必须
├─ pic_urlstring非必须
├─ descstring非必须
├─ min_pricestring非必须
├─ sub_pricestring非必须
├─ total_countstring非必须
├─ sortstring非必须
├─ expire_typestring非必须
├─ expire_daystring非必须
├─ begin_timestring非必须
├─ end_timestring非必须
├─ appoint_typestring非必须
├─ rulestring非必须
├─ is_memberstring非必须
├─ is_deletestring非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须

预览会员卡

基本信息

Path: /plugin/vip_card/api/order/preview

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ typestring非必须
├─ type_infostring非必须
├─ discountstring非必须
├─ is_discountstring非必须
├─ is_free_deliverystring非必须
├─ statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ vip_idstring非必须
├─ namestring非必须
├─ expire_daystring非必须
├─ pricestring非必须
├─ numstring非必须
├─ send_integral_numstring非必须
├─ send_integral_typestring非必须
├─ send_balancestring非必须
├─ titlestring非必须
├─ contentstring非必须
├─ statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ vipCardsobject []非必须

item 类型: object

├─ idstring非必须
├─ detail_idstring非必须
├─ card_idstring非必须
├─ send_numstring非必须
├─ is_deletestring非必须
├─ cardsobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pic_urlstring非必须
├─ descriptionstring非必须
├─ expire_typestring非必须
├─ expire_daystring非必须
├─ begin_timestring非必须
├─ end_timestring非必须
├─ total_countstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ vipCouponsobject []非必须

item 类型: object

├─ idstring非必须
├─ detail_idstring非必须
├─ coupon_idstring非必须
├─ send_numstring非必须
├─ is_deletestring非必须
├─ couponsobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ typestring非必须
├─ discountstring非必须
├─ pic_urlstring非必须
├─ descstring非必须
├─ min_pricestring非必须
├─ sub_pricestring非必须
├─ total_countstring非必须
├─ sortstring非必须
├─ expire_typestring非必须
├─ expire_daystring非必须
├─ begin_timestring非必须
├─ end_timestring非必须
├─ appoint_typestring非必须
├─ rulestring非必须
├─ is_memberstring非必须
├─ is_deletestring非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须

预售--插件

分享海报

基本信息

Path: /plugin/advance/api/goods/poster

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
goods_id 是 39590 预售商品id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pic_urlstring非必须

商品列表

基本信息

Path: /plugin/advance/api/goods/index

Method: GET

接口描述:

其他参数同商品,唯独attr下规格有不同参数,定金及膨胀金

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stocknumber非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attrobject []非必须

item 类型: object

├─ idstring非必须
├─ goods_idstring非必须
├─ sign_idstring非必须
├─ stockstring非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightstring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ depositstring非必须定金
├─ swell_depositstring非必须膨胀金
├─ advanceGoodsobject非必须
├─ idstring非必须
├─ goods_idstring非必须
├─ mall_idstring非必须
├─ ladder_rulesstring非必须
├─ depositstring非必须
├─ swell_depositstring非必须
├─ start_prepayment_atstring非必须
├─ end_prepayment_atstring非必须
├─ pay_limitstring非必须
├─ is_deletestring非必须
├─ cover_picstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

商品详情

基本信息

Path: /plugin/advance/api/goods/detail

Method: GET

接口描述:

其他参数同商品,唯独attr下规格有不同参数,定金及膨胀金

请求参数

Query

参数名称 是否必须 示例 备注
id 是 商品ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ mch_idnumber非必须
├─ goods_warehouse_idnumber非必须
├─ statusnumber非必须
├─ pricestring非必须
├─ use_attrnumber非必须
├─ attr_groupsobject []非必须

item 类型: object

├─ attr_group_idnumber非必须
├─ attr_group_namestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ goods_stocknumber非必须
├─ virtual_salesnumber非必须
├─ confine_countnumber非必须
├─ piecesnumber非必须
├─ foreheadstring非必须
├─ freight_idnumber非必须
├─ give_integralnumber非必须
├─ give_integral_typenumber非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typenumber非必须
├─ accumulativenumber非必须
├─ individual_sharenumber非必须
├─ attr_setting_typenumber非必须
├─ is_levelnumber非必须
├─ is_level_alonenumber非必须
├─ share_typenumber非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesnumber非必须
├─ sortnumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ payment_peoplenumber非必须
├─ payment_numnumber非必须
├─ payment_amountstring非必须
├─ payment_ordernumber非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cover_picstring非必须
├─ unitstring非必须
├─ detailstring非必须
├─ video_urlstring非必须
├─ level_shownumber非必须
├─ is_salesnumber非必须
├─ attrobject []非必须

item 类型: object

├─ idstring非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stockstring非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ is_deletenumber非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ price_membernumber非必须
├─ member_price_listobject []非必须

item 类型: object

├─ idstring非必须
├─ levelnumber非必须
├─ pricestring非必须
├─ goods_attr_idnumber非必须
├─ is_deletenumber非必须
├─ goods_idnumber非必须
├─ depositstring非必须定金
├─ swell_depositstring非必须膨胀金
├─ extraobject []非必须

item 类型: object

├─ valuestring必须
├─ namestring必须
├─ goods_numnumber非必须
├─ goods_nostring非必须
├─ goods_weightnumber非必须
├─ servicesstring []非必须

item 类型: string

├─ 非必须
├─ cardsstring []非必须

item 类型: string

├─ 非必须
├─ price_minnumber非必须
├─ price_maxnumber非必须
├─ pic_urlobject []非必须

item 类型: object

├─ idstring非必须
├─ pic_urlstring非必须
├─ sharenumber非必须
├─ salesnumber非必须
├─ favoriteboolean非必须
├─ goods_marketingobject非必须
├─ limitstring非必须
├─ pickupstring非必须
├─ shippingstring非必须
├─ goods_marketing_awardobject非必须
├─ cardobject非必须
├─ titlestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ integralobject非必须
├─ titlestring非必须
├─ integralMallGoodsobject非必须
├─ idstring非必须
├─ goods_idnumber非必须
├─ mall_idnumber非必须
├─ ladder_rulesstring非必须
├─ depositstring非必须
├─ swell_depositstring非必须
├─ start_prepayment_atstring非必须
├─ end_prepayment_atstring非必须
├─ pay_limitnumber非必须
├─ is_deletenumber非必须

定金付款

基本信息

Path: /plugin/advance/api/order/advance

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
goods_id text 是 商品ID
goods_attr_id text 是 商品规格ID
goods_num text 是 商品数量
id text 否 重新付款时需要传

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须

首页轮播图

基本信息

Path: /plugin/advance/api/goods/banner

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ pic_urlstring必须
├─ titlestring必须
├─ page_urlstring必须
├─ open_typestring必须
├─ paramsstring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ deleted_atstring必须
├─ updated_atstring必须

礼物--插件

海报

基本信息

Path: /plugin/gift/api/gift-index/poster

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
gift_id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ pic_urlstring必须海报URL

后台--基本设置

基本信息

Path: /plugin/gift/mall/setting/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ titlestring非必须页面标题
├─ typestring非必须选择玩法
├─ auto_refundnumber非必须自动退款
├─ auto_remindnumber非必须送礼未成功自动提醒
├─ bless_wordstring非必须祝福语
├─ ask_giftstring非必须求礼物话术语
├─ is_smsnumber非必须短信
├─ is_mailnumber非必须邮件
├─ is_printnumber非必须打印
├─ payment_typestring []非必须支付方式

item 类型: string

├─ 非必须
├─ posterobject非必须
├─ bg_picobject非必须
├─ urlstring非必须
├─ picobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ headobject非必须
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ poster_bgobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ qr_codeobject非必须
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ typenumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ nicknameobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ nickname_shareobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ nameobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ descobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ priceobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ textstring非必须
├─ file_typestring非必须

填写地址预览

基本信息

Path: /plugin/gift/api/gift-order/gift-convert-preview

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
form_data 是 {"list":[{"mch_id":0,"goods_list":[],"use_integral":0,"user_coupon_id":0,"distance":0,"remark":"","order_form":[]}],"address_id":0}

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ mch_listobject []非必须

item 类型: object

├─ mchobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ goods_liststring []非必须

item 类型: string

├─ 非必须
├─ form_dataobject非必须
├─ mch_idnumber非必须
├─ goods_liststring []非必须

item 类型: string

├─ 非必须
├─ use_integralnumber非必须
├─ user_coupon_idnumber非必须
├─ distancenumber非必须
├─ remarkstring非必须
├─ order_formstring []非必须

item 类型: string

├─ 非必须
├─ express_pricestring非必须
├─ remarkstring非必须
├─ order_form_datastring []非必须

item 类型: string

├─ 非必须
├─ total_goods_pricestring非必须
├─ total_goods_original_pricestring非必须
├─ member_discountstring非必须
├─ couponobject非必须
├─ enabledboolean非必须
├─ useboolean非必须
├─ coupon_discountstring非必须
├─ user_coupon_idnumber非必须
├─ coupon_errornull非必须
├─ integralobject非必须
├─ can_useboolean非必须
├─ useboolean非必须
├─ use_numnumber非必须
├─ deduction_pricestring非必须
├─ deliveryobject非必须
├─ send_typestring非必须
├─ disabledboolean非必须
├─ send_type_listobject []非必须

item 类型: object

├─ namestring必须
├─ valuestring必须
├─ storenull非必须
├─ store_select_enableboolean非必须
├─ cityobject非必须
├─ errorstring非必须
├─ total_pricestring非必须
├─ total_pricestring非必须
├─ price_enableboolean非必须
├─ addressnull非必须
├─ address_enableboolean非必须
├─ has_zitiboolean非必须
├─ custom_currency_allstring []非必须

item 类型: string

├─ 非必须
├─ allZitiboolean非必须
├─ hasCityboolean非必须

我参与的列表/详情

基本信息

Path: /plugin/gift/api/order-list/join-list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ gift_idstring非必须
├─ is_turnstring非必须
├─ turn_nostring非必须
├─ turn_user_idstring非必须
├─ is_receivestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_winstring非必须
├─ tokenstring非必须
├─ giftLogobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ numstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_confirmstring非必须
├─ typestring非必须
├─ open_timestring非必须
├─ open_numstring非必须
├─ open_typestring非必须
├─ bless_wordstring非必须
├─ auto_refund_timestring非必须
├─ sendOrderobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ user_idstring非必须
├─ gift_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_refundstring非必须
├─ is_confirmstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ support_pay_typesstring非必须
├─ tokenstring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ send_order_idstring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ goods_infostring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ is_refundstring非必须
├─ refund_statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ receive_numstring非必须
├─ refund_pricestring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ giftOrderobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ order_nostring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ numstring非必须
├─ order_idstring非必须
├─ typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ user_order_idstring非必须
├─ is_refundstring非必须
├─ orderobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ mch_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ express_original_pricestring非必须
├─ express_pricestring非必须
├─ total_goods_pricestring非必须
├─ total_goods_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ use_user_coupon_idstring非必须
├─ coupon_discount_pricestring非必须
├─ use_integral_numstring非必须
├─ integral_deduction_pricestring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ remarkstring非必须
├─ order_formstring非必须
├─ wordsstring非必须
├─ seller_remarkstring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_sendstring非必须
├─ send_timestring非必须
├─ customer_namestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ is_salestring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ cancel_statusstring非必须
├─ cancel_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_recyclestring非必须
├─ send_typestring非必须
├─ offline_qrcodestring非必须
├─ clerk_idstring非必须
├─ store_idstring非必须
├─ signstring非必须
├─ tokenstring非必须
├─ support_pay_typesstring非必须
├─ is_commentstring非必须
├─ comment_timestring非必须
├─ sale_statusstring非必须
├─ statusstring非必须
├─ back_pricestring非必须
├─ auto_cancel_timestring非必须
├─ auto_confirm_timenull非必须
├─ auto_sales_timenull非必须
├─ distancestring非必须
├─ city_mobilestring非必须
├─ locationnull非必须
├─ city_namenull非必须
├─ city_infonull非必须
├─ storenull非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infostring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_refundstring非必须
├─ refund_statusstring非必须
├─ back_pricestring非必须
├─ signstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ orderRefundnull非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ goodsAttrobject非必须
├─ idstring非必须
├─ goods_idstring非必须
├─ sign_idstring非必须
├─ stockstring非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightstring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ sendUserobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ statusstring非必须
├─ status_numnumber非必须
├─ detailobject []非必须

item 类型: object

├─ refundnumber非必须-1不可换货0可以1换货中
├─ detail_idstring非必须订单详情ID
├─ namestring非必须商品名
├─ cover_picstring非必须商品图
├─ numstring非必须数量
├─ attrstring非必须规格
├─ goods_idinteger必须
├─ goods_attr_idinteger必须
├─ goods_infostring []必须

item 类型: string

├─ 非必须
├─ order_nostring非必须订单号
├─ is_big_giftnumber非必须是否是大礼包1是0否
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

我收到的列表/详情

基本信息

Path: /plugin/gift/api/order-list/win-list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ gift_idstring非必须
├─ is_turnstring非必须
├─ turn_nostring非必须
├─ turn_user_idstring非必须
├─ is_receivestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_winstring非必须
├─ tokenstring非必须
├─ giftLogobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ numstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_confirmstring非必须
├─ typestring非必须
├─ open_timestring非必须
├─ open_numstring非必须
├─ open_typestring非必须
├─ bless_wordstring非必须
├─ auto_refund_timestring非必须
├─ sendOrderobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ user_idstring非必须
├─ gift_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_refundstring非必须
├─ is_confirmstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ support_pay_typesstring非必须
├─ tokenstring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ send_order_idstring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ goods_infostring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ is_refundstring非必须
├─ refund_statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ receive_numstring非必须
├─ refund_pricestring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ giftOrderobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ order_nostring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ numstring非必须
├─ order_idstring非必须
├─ typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ user_order_idstring非必须
├─ is_refundstring非必须
├─ orderobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ mch_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ express_original_pricestring非必须
├─ express_pricestring非必须
├─ total_goods_pricestring非必须
├─ total_goods_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ use_user_coupon_idstring非必须
├─ coupon_discount_pricestring非必须
├─ use_integral_numstring非必须
├─ integral_deduction_pricestring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ remarkstring非必须
├─ order_formstring非必须
├─ wordsstring非必须
├─ seller_remarkstring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_sendstring非必须
├─ send_timestring非必须
├─ customer_namestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ is_salestring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ cancel_statusstring非必须
├─ cancel_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_recyclestring非必须
├─ send_typestring非必须
├─ offline_qrcodestring非必须
├─ clerk_idstring非必须
├─ store_idstring非必须
├─ signstring非必须
├─ tokenstring非必须
├─ support_pay_typesstring非必须
├─ is_commentstring非必须
├─ comment_timestring非必须
├─ sale_statusstring非必须
├─ statusstring非必须
├─ back_pricestring非必须
├─ auto_cancel_timestring非必须
├─ auto_confirm_timenull非必须
├─ auto_sales_timenull非必须
├─ distancestring非必须
├─ city_mobilestring非必须
├─ locationnull非必须
├─ city_namenull非必须
├─ city_infonull非必须
├─ storenull非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infostring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_refundstring非必须
├─ refund_statusstring非必须
├─ back_pricestring非必须
├─ signstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ orderRefundnull非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ goodsAttrobject非必须
├─ idstring非必须
├─ goods_idstring非必须
├─ sign_idstring非必须
├─ stockstring非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightstring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ sendUserobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ statusstring非必须
├─ status_numnumber非必须
├─ detailobject []非必须

item 类型: object

├─ refundnumber非必须-1不可换货0可以1换货中
├─ detail_idstring非必须订单详情ID
├─ namestring非必须商品名
├─ cover_picstring非必须商品图
├─ numstring非必须数量
├─ attrstring非必须规格
├─ goods_idinteger必须
├─ goods_attr_idinteger必须
├─ goods_infostring []必须

item 类型: string

├─ 非必须
├─ order_nostring非必须订单号
├─ is_big_giftnumber非必须是否是大礼包1是0否
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

我送出的

基本信息

Path: /plugin/gift/api/order-list/send-list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ numstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_confirmstring必须
├─ typestring必须
├─ open_timestring必须
├─ open_numstring必须
├─ open_typestring必须
├─ bless_wordstring必须
├─ auto_refund_timestring必须
├─ userOrderobject []必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ gift_idstring必须
├─ is_turnstring必须
├─ turn_nostring必须
├─ turn_user_idstring必须
├─ is_receivestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_winstring必须
├─ tokenstring必须
├─ userobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ userobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ sendOrderobject []必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ user_idstring必须
├─ gift_idstring必须
├─ order_nostring必须
├─ total_pricestring必须
├─ total_pay_pricestring必须
├─ is_paystring必须
├─ pay_typestring必须
├─ pay_timestring必须
├─ is_refundstring必须
├─ is_confirmstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ support_pay_typesstring必须
├─ tokenstring必须
├─ detailobject []必须

item 类型: object

├─ idstring必须
├─ send_order_idstring必须
├─ goods_idstring必须
├─ goods_attr_idstring必须
├─ goods_infostring必须
├─ numstring必须
├─ unit_pricestring必须
├─ total_original_pricestring必须
├─ total_pricestring必须
├─ is_refundstring必须
├─ refund_statusstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ receive_numstring必须
├─ refund_pricestring必须
├─ goodsobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitstring,null非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ statusstring必须
├─ is_big_giftnumber必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

我送出的详情

基本信息

Path: /plugin/gift/api/order-list/send-detail

Method: GET

接口描述:

convert_list     已领取
wait_list           等待
refund_list       已退款
success_list     成功

请求参数

Query

参数名称 是否必须 示例 备注
gift_id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ detailobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ numstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_confirmstring非必须
├─ typestring非必须
├─ open_timestring非必须
├─ open_numstring非必须
├─ open_typestring非必须
├─ bless_wordstring非必须
├─ auto_refund_timestring非必须
├─ statusstring非必须
├─ status_numnumber非必须
├─ convert_listobject非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ total_pricenumber非必须
├─ wait_listobject非必须
├─ listobject []非必须

item 类型: object

├─ namestring非必须
├─ cover_picstring非必须
├─ goods_infostring非必须
├─ numstring非必须
├─ total_pricestring非必须
├─ total_pricenumber非必须
├─ order_nostring非必须
├─ pay_timestring非必须

插件相关设置

基本信息

Path: /plugin/gift/api/gift-index/config

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ titlestring非必须标题
├─ typestring []非必须送礼方式direct_open直接送time_open定时开奖num_open满人开奖

item 类型: string

├─ 非必须
├─ bless_wordstring非必须祝福语
├─ ask_giftstring非必须求礼物语
├─ explainstring非必须规则
├─ backgroundobject非必须背景图
├─ bg_picstring非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ themeobject非必须主题
├─ idstring非必须
├─ activestring非必须
├─ textstring非必须
├─ pic_urlstring非必须

填写地址提交

基本信息

Path: /plugin/gift/api/gift-order/gift-convert

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
form_data 是 {"list":[{"mch_id":0,"goods_list":[],"use_integral":0,"user_coupon_id":0,"distance":0,"remark":"","order_form":[]}],"address_id":0}

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject必须
├─ tokenstring必须
├─ queue_idstring必须

礼物下单

基本信息

Path: /plugin/gift/api/gift-order/order-submit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 否 礼物订单重新付款的时候传入
type 是
open_time 是
open_num 是
open_type 是
bless_word 是
form_data 是
bless_music 是 语音

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ tokenstring非必须
├─ queue_idstring非必须

礼物记录

基本信息

Path: /plugin/gift/mall/record/tribute

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
keyword 否 name/order_no/nickname/user_id
keyword_1 否
platform 否 平台标识
type 否 礼物类型 直接送 direct_open 定时送 time_open 满人送 num_open
page 否 页码
start_date 否 开始时间
end_date 否 结束时间

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ numstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_confirmstring必须
├─ typestring必须
├─ open_timestring必须
├─ open_numstring必须
├─ open_typestring必须
├─ bless_wordstring必须
├─ auto_refund_timestring必须
├─ userOrderobject []必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ gift_idstring必须
├─ is_turnstring必须
├─ turn_nostring必须
├─ turn_user_idstring必须
├─ is_receivestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_winstring必须
├─ tokenstring必须
├─ userobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ giftOrderNumobject []必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ order_nostring必须
├─ goods_idstring必须
├─ goods_attr_idstring必须
├─ numstring必须
├─ order_idstring必须
├─ typestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ user_order_idstring必须
├─ is_refundstring必须
├─ userobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ sendOrderobject []必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ user_idstring必须
├─ gift_idstring必须
├─ order_nostring必须
├─ total_pricestring必须
├─ total_pay_pricestring必须
├─ is_paystring必须
├─ pay_typestring必须
├─ pay_timestring必须
├─ is_refundstring必须
├─ is_confirmstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ support_pay_typesstring必须
├─ tokenstring必须
├─ detailobject []必须

item 类型: object

├─ idstring必须
├─ send_order_idstring必须
├─ goods_idstring必须
├─ goods_attr_idstring必须
├─ goods_infostring必须
├─ numstring必须
├─ unit_pricestring必须
├─ total_original_pricestring必须
├─ total_pricestring必须
├─ is_refundstring必须
├─ refund_statusstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ receive_numstring必须
├─ refund_pricestring必须
├─ goodsobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull,string非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ statusstring必须
├─ is_big_giftnumber必须是否大礼包1是0否
├─ join_numnumber必须参与数
├─ win_numnumber必须领取数
├─ address_statusstring必须填写地址状态
├─ total_pay_pricenumber必须支付金额
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

被转赠

基本信息

Path: /plugin/gift/api/gift-order/get-turn

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
turn_no 是 转赠码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgobject非必须

转赠

基本信息

Path: /plugin/gift/api/gift-order/turn

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ turn_nostring非必须转赠码

送礼取消支付

基本信息

Path: /plugin/gift/api/gift-order/order-cancel

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
gift_id 是 礼物ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

领取记录

基本信息

Path: /plugin/gift/mall/record/receive

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
keyword 否 name/nickname/user_id/gift_order_id
keyword_1 否
start_date 否 开始时间
end_date 否 结束时间
page 否 1
gift_id 否 233

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ gift_idstring非必须
├─ is_turnstring非必须
├─ turn_nostring非必须
├─ turn_user_idstring非必须
├─ is_receivestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_winstring非必须
├─ tokenstring非必须
├─ userobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ giftLogobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ numstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_confirmstring非必须
├─ typestring非必须
├─ open_timestring非必须
├─ open_numstring非必须
├─ open_typestring非必须
├─ bless_wordstring非必须
├─ auto_refund_timestring非必须
├─ userobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ sendOrderobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ user_idstring非必须
├─ gift_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_refundstring非必须
├─ is_confirmstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ support_pay_typesstring非必须
├─ tokenstring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ send_order_idstring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ goods_infostring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ is_refundstring非必须
├─ refund_statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ receive_numstring非必须
├─ refund_pricestring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ giftOrderobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ order_nostring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ numstring非必须
├─ order_idstring非必须
├─ typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ user_order_idstring非必须
├─ is_refundstring非必须
├─ orderobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ mch_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ express_original_pricestring非必须
├─ express_pricestring非必须
├─ total_goods_pricestring非必须
├─ total_goods_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ use_user_coupon_idstring非必须
├─ coupon_discount_pricestring非必须
├─ use_integral_numstring非必须
├─ integral_deduction_pricestring非必须
├─ namestring非必须
├─ mobilestring非必须
├─ addressstring非必须
├─ remarkstring非必须
├─ order_formstring非必须
├─ wordsstring非必须
├─ seller_remarkstring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_sendstring非必须
├─ send_timestring非必须
├─ customer_namestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ is_salestring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ cancel_statusstring非必须
├─ cancel_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_recyclestring非必须
├─ send_typestring非必须
├─ offline_qrcodestring非必须
├─ clerk_idstring非必须
├─ store_idstring非必须
├─ signstring非必须
├─ tokenstring非必须
├─ support_pay_typesstring非必须
├─ is_commentstring非必须
├─ comment_timestring非必须
├─ sale_statusstring非必须
├─ statusstring非必须
├─ back_pricestring非必须
├─ auto_cancel_timestring非必须
├─ auto_confirm_timenull非必须
├─ auto_sales_timenull非必须
├─ distancestring非必须
├─ city_mobilestring非必须
├─ locationnull非必须
├─ city_namenull非必须
├─ city_infonull非必须
├─ storenull非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infostring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_refundstring非必须
├─ refund_statusstring非必须
├─ back_pricestring非必须
├─ signstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitnull非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ goodsAttrobject非必须
├─ idstring非必须
├─ goods_idstring非必须
├─ sign_idstring非必须
├─ stockstring非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightstring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ parentnull非必须
├─ address_statusstring非必须
├─ turn_listobject非必须
├─ gift_userobject非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ platformstring非必须
├─ turn_numnumber非必须
├─ parent_usernull非必须
├─ self_userobject非必须
├─ nicknamestring非必须
├─ avatarstring非必须
├─ platformstring非必须
├─ detailobject []非必须

item 类型: object

├─ detail_idstring非必须
├─ namestring非必须
├─ cover_picstring非必须
├─ numstring非必须
├─ attrstring非必须
├─ goods_idinteger必须
├─ goods_attr_idinteger必须
├─ goods_infostring []必须

item 类型: string

├─ 非必须
├─ order_nostring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

领取详情

基本信息

Path: /plugin/gift/api/gift-index/gift

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
gift_id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ numstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_confirmstring非必须
├─ typestring非必须
├─ open_timestring非必须开奖时间
├─ open_numstring非必须开奖人数
├─ open_typestring非必须1一个得奖0多人随机得奖品
├─ bless_wordstring非必须祝福语
├─ auto_refund_timestring非必须
├─ userOrderstring []非必须

item 类型: string

├─ 非必须
├─ winUserstring []非必须中奖用户

item 类型: string

├─ 非必须
├─ userobject非必须送礼人
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ total_balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ platformstring非必须
├─ temp_parent_idstring非必须
├─ sendOrderobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ user_idstring非必须
├─ gift_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ is_paystring非必须
├─ pay_typestring非必须
├─ pay_timestring非必须
├─ is_refundstring非必须
├─ is_confirmstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ support_pay_typesstring非必须
├─ tokenstring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ send_order_idstring非必须
├─ goods_idstring非必须
├─ goods_attr_idstring非必须
├─ goods_infostring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ is_refundstring非必须
├─ refund_statusstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ receive_numstring非必须
├─ refund_pricestring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitstring非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ numnumber非必须参与人数
├─ win_numnumber非必须中奖人数
├─ win_timestring非必须被领光时间
├─ win_goods_namestring非必须礼物领取情况文字
├─ win_goods_statusnumber非必须礼物领取状态
├─ refund_timenumber非必须退款剩余时间
├─ is_gift_nullnumber非必须是否被领光
├─ statusnumber非必须当前用户中奖状态1中0否
├─ address_statusnumber非必须当前用户地址是否填写1是0否
├─ join_statusnumber非必须当前用户参与状态1是0否
├─ open_statusnumber非必须开奖状态1开0否
├─ is_big_giftnumber非必须是否大礼包1是0否
├─ settingnumber非必须

下单

订单信息预览

基本信息

Path: /api/order/preview

Method: GET

接口描述:

shuominhg

请求参数

Query

参数名称 是否必须 示例 备注
form_data 是 {"list":[{"mch_id":0,"goods_list":[{"id":39185,"attr":[{"attr_id":2,"attr_group_id":1},{"attr_id":4,"attr_group_id":2}],"num":1,"cat_id":0,"goods_attr_id":76798,"cart_id":0}],"distance":0,"remark":"","order_form":[],"use_integral":0,"user_coupon_id":0}],"address_id":0}

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ mch_listobject []非必须商户列表

item 类型: object

├─ mchobject非必须商户信息
├─ idnumber非必须商户id,主商城为0
├─ namestring非必须商户名称
├─ goods_listobject []非必须商品列表

item 类型: object

├─ idnumber非必须商品id
├─ namestring非必须商品名
├─ numnumber非必须购买数量
├─ accumulativenumber非必须
├─ unit_pricestring非必须商品单价
├─ total_original_pricestring非必须商品小记总价,优惠前
├─ total_pricestring非必须商品小记总价,优惠后
├─ attr_listobject []非必须商品规格信息

item 类型: object

├─ attr_group_namestring非必须规格组名称
├─ attr_group_idnumber非必须规格组id
├─ attr_idnumber非必须规格id
├─ attr_namestring非必须规格值
├─ discountsstring []非必须

item 类型: string

├─ 非必须
├─ cover_picstring非必须商品图片
├─ is_level_alonenumber非必须
├─ custom_currencystring []非必须

item 类型: string

├─ 非必须
├─ goods_warehouse_idnumber非必须商品库的商品id
├─ signstring非必须
├─ form_dataobject非必须表单提交form_data信息中对应商户的信息
├─ mch_idnumber非必须
├─ goods_listobject []非必须

item 类型: object

├─ idnumber非必须
├─ attrobject []非必须

item 类型: object

├─ attr_idnumber必须
├─ attr_group_idnumber必须
├─ numnumber非必须
├─ cat_idnumber非必须
├─ goods_attr_idnumber非必须
├─ cart_idnumber非必须
├─ distancenumber非必须
├─ remarkstring非必须
├─ order_formstring []非必须

item 类型: string

├─ 非必须
├─ use_integralnumber非必须
├─ user_coupon_idnumber非必须
├─ express_pricestring非必须运费
├─ remarkstring非必须订单备注
├─ order_form_dataobject []非必须已填写的自定义表单

item 类型: object

├─ keystring非必须表单类型
├─ labelstring非必须表单名称
├─ requirednumber非必须是否必填:0=非必填,1=必填
├─ valuestring非必须用户填写的值
├─ total_goods_pricestring非必须商品小记总价(优惠后)
├─ total_goods_original_pricestring非必须商品小记总价(优惠前)
├─ member_discountstring非必须
├─ couponobject非必须优惠券信息
├─ enabledboolean非必须是否可以使用优惠券
├─ useboolean非必须是否已使用优惠券
├─ coupon_discountstring非必须
├─ user_coupon_idnumber非必须使用的优惠券id
├─ coupon_errornull非必须优惠券错误信息
├─ integralobject非必须积分抵扣信息
├─ can_useboolean非必须是否可以使用积分抵扣
├─ useboolean非必须是否已使用积分抵扣
├─ use_numnumber非必须使用积分数量
├─ deduction_pricestring非必须积分抵扣的金额
├─ deliveryobject非必须配送方式
├─ send_typestring非必须配送方式:express=快递,offline=自提,city=同城
├─ disabledboolean非必须
├─ send_type_listobject []非必须可选配送方式列表

item 类型: object

├─ namestring必须配送方式显示名称
├─ valuestring必须配送方式
├─ storeobject非必须所选门店信息
├─ idnumber非必须门店id
├─ mall_idstring非必须所属商城id
├─ mch_idstring非必须所属商户id
├─ namestring非必须门店名称
├─ mobilestring非必须门店电话
├─ addressstring非必须门店地址
├─ longitudestring非必须门店经度
├─ latitudestring非必须门店纬度
├─ distancestring非必须门店距离(eg. 100m | 65.54km)
├─ store_select_enableboolean非必须是否可以选择门店
├─ total_pricestring非必须商户总价小记(优惠后)
├─ order_formobject非必须下单自定义表单信息
├─ namestring非必须表单标题
├─ statusstring非必须状态:0=未启用,1=启用,(请使用非全等判断)
├─ valueobject []非必须表单详细内容

item 类型: object

├─ keystring非必须表单类型(text、radio、checkbox、date...)
├─ key_namestring非必须表单类型(中文)
├─ namestring非必须表单名称
├─ is_requirednumber非必须是否必填:0=非必填,1=必填(请使用非全等判断)
├─ hintstring非必须表单提示文字
├─ total_pricestring非必须订单总金额(含运费)
├─ price_enableboolean非必须金额是否满足下单要求
├─ addressobject非必须收获地址信息
├─ idnumber非必须收货地址ID
├─ user_idnumber非必须
├─ namestring非必须收货人姓名
├─ province_idnumber非必须省份id
├─ provincestring非必须省份名称
├─ city_idnumber非必须城市id
├─ citystring非必须城市名称
├─ district_idnumber非必须县/区id
├─ districtstring非必须县/区名称
├─ mobilestring非必须收货人手机
├─ detailstring非必须详细收获地址
├─ is_defaultnumber非必须是否是默认地址:0=否,1=是
├─ latitudestring非必须收货地址纬度
├─ longitudestring非必须收货地址经度
├─ locationstring非必须
├─ address_enableboolean非必须所选收货地址是否可以发货
├─ has_zitiboolean非必须所有订单中是否含有自体订单
├─ custom_currency_allstring []非必须

item 类型: string

├─ 非必须
├─ allZitiboolean非必须是否所有订单都是自提订单
├─ hasCityboolean非必须

diy接口

搜索框组件

基本信息

Path: /search

Method: GET

接口描述:

补充diy页面接口的组件数据中id=search的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
colorstring必须搜索框背景色
backgroundstring必须组件背景色
radiusinteger必须搜索框圆角
placeholderstring必须搜索框提示文字
textColorstring必须搜索框文字颜色
textPositionstring必须搜索框文字位置

专题

基本信息

Path: /topic

Method: GET

接口描述:

补充diy页面接口的组件数据中id=topic的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
stylestring必须样式

枚举: normal,list

枚举备注: normal--简易模式 list--列表模式

countinteger必须显示数量仅在style=normal下有效
logo_1string必须专题图标仅在count=1时有效
logo_2string必须专题图标仅在count=2时有效
iconstring必须左侧图标仅在style=normal时有效
cat_showboolean必须是否显示分类,仅在style=list时有效
topic_listobject []必须专题列表

item 类型: object

├─ idinteger必须专题id
├─ titlestring必须专题名称
listobject []必须分类列表仅在style=list时有效

item 类型: object

├─ cat_idinteger必须分类id
├─ cat_namestring必须原名称
├─ namestring必须显示的名称
├─ childrenobject []必须专题列表

item 类型: object

├─ idstring必须专题id
├─ titlestring必须专题名称
├─ cover_picstring必须专题图片
├─ read_countstring必须浏览人数
├─ layoutinteger必须样式

枚举: 1,2,0

枚举备注: 0--小图模式 1--大图模式 2--多图模式

├─ abstractstring必须摘要
├─ pic_listobject []必须图片列表仅在layout=2时有效

item 类型: object

├─ urlstring必须图片地址
├─ customboolean必须是否自定义专题
├─ numberinteger必须自定义专题数量(custom=true下有效)

倒计时

基本信息

Path: /timer

Method: GET

接口描述:

补充diy页面接口的组件数据中id=timer的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
picUrlstring必须图片地址
linkobject必须具体参考公共信息link
startDateTimestring必须开始时间
endDateTimestring必须结束时间

公共信息

基本信息

Path: /diy

Method: GET

接口描述:

组件数据中,公共部分

请求参数

返回数据

名称类型是否必须默认值备注其他信息
paramsobject []必须链接参数

item 类型: object

├─ keystring必须参数key
├─ valuestring必须参数值
linkobject必须链接
├─ namestring必须链接名称
├─ open_typestring必须链接类型
├─ valuestring必须链接路由
├─ new_link_urlstring必须链接拼接路由
├─ paramsobject []必须链接参数

item 类型: object

├─ keystring必须参数key
├─ valuestring必须参数值

公告

基本信息

Path: /notice

Method: GET

接口描述:

补充diy页面接口的组件数据中id=notice的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
namestring必须名称
contentstring必须内容
iconstring必须图标地址
textColorstring必须文字颜色
backgroundstring必须背景色
headerUrlstring必须弹窗头部图片地址
btnColorstring必须弹窗按钮背景色
btnWidthnumber必须弹窗按钮宽度
btnHeightnumber必须弹窗按钮高度
btnRadiusnumber必须弹窗按钮圆角
btnTextstring必须弹窗按钮文本
btnTextColorstring必须弹窗按钮文本颜色

关联链接

基本信息

Path: /link

Method: GET

接口描述:

补充diy页面接口的组件数据中id=link的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
titlestring必须标题
textLeftnumber必须标题左边距
linkobject必须具体见公共信息link
picSwitchboolean必须图片开关
arrowsSwitchboolean必须箭头开关
picUrlstring必须图片地址
picLeftnumber必须图片左边距
colorstring必须标题颜色
backgroundstring必须背景色

商品

基本信息

Path: /goods

Method: GET

接口描述:

补充diy页面接口的组件数据中id=goods的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
showCatboolean必须是否展示分类
catPositionstring必须分类位置(showCat=true时有效)

枚举: left,top

枚举备注: left--左侧位置 top--顶部位置

catStyleinteger必须分类样式(catPosition=top时有效)

枚举: 1,2

枚举备注: 1--页签形式 2--填充形式

catListobject []必须分类列表

item 类型: object

├─ idinteger必须分类id
├─ namestring必须原始名称
├─ menuNamestring必须显示名称
├─ staticGoodsboolean必须是否开启自定义商品
├─ goodsNuminteger必须商品数量(staticGoods=false时有效)
├─ goodsListstring []必须同下list

item 类型: string

├─ 非必须
listobject []必须商品列表

item 类型: object

├─ idinteger必须商品id
├─ mch_idinteger必须商品所属商户id
├─ signstring必须商品所属插件
├─ namestring必须商品名称
├─ cover_picstring必须缩略图
├─ original_pricenumber必须原价
├─ unitstring必须单位
├─ page_urlstring必须商品详情路径
├─ is_negotiableinteger必须是否价格面议

枚举: 1,0

枚举备注: 1--价格面议 0--否

├─ is_levelinteger必须是否享受会员价

枚举: 1,0

枚举备注: 1--享受会员价 0--否

├─ level_pricenumber必须会员价
├─ pricenumber必须售价
├─ price_contentstring必须商品售价文本
├─ is_salesinteger必须是否显示销量

枚举: 1,0

枚举备注: 1--显示销量 0--不显示

├─ salesstring必须销量文本
├─ vip_card_appointobject必须
├─ discountstring必须折扣
├─ is_my_vip_card_goodsinteger必须登录用户是否享受商品折扣

枚举: 1,0

枚举备注: 1--是 0--否

├─ is_vip_card_userinteger必须登录用户是不是会员

枚举: 1,0

枚举备注: 1--是 0--否

listStyleinteger必须商品列表样式

枚举: -1,0,1,2,3

枚举备注: -1--列表模式 0--左右滑动 1--一行一个 2--一行两个 3--一行三个

goodsCoverProportionstring必须封面图宽高比例

枚举: 1-1,3-2

枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2

fillinteger必须封面图填充方式

枚举: 1,0

枚举备注: 1--填充 2--留白

goodsStyleinteger必须单品样式

枚举: 1,2,3,4

枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中

showGoodsNameboolean必须是否显示商品名称
showGoodsPriceboolean必须是否显示商品价格(售价和原价)
showBuyBtnboolean必须是否显示购买按钮
buyBtnstring必须购买按钮样式

枚举: cart,add,text

枚举备注: cart--购物车 add--加号 text--文字样式

buyBtnStyleinteger必须按钮样式仅在buyBtn=text时

枚举: 1,2,3,4

枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条

buyBtnTextstring必须按钮文本仅在buyBtn=text时有效
showGoodsTagboolean必须是否展示商品角标
customizeGoodsTagboolean必须是否自定义角标
goodsTagPicUrlstring必须商品角标地址

图文详情

基本信息

Path: /image-text

Method: GET

接口描述:

补充diy页面接口的组件数据中id=image-text的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
contentstring必须图文详情内容

图片广告

基本信息

Path: /rubik

Method: GET

接口描述:

补充diy页面接口的组件数据中id=rubik的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
styleinteger必须样式

枚举: 1,0,2,3,4,5,6,7,8

枚举备注: 0--一张图 1--两张图 2--三张图 3--四张图 4--两张图左右平分 5--三张图左右平分 6--四张图左右平分 7--四张图上下左右平分 8--自定义魔方

spaceinteger必须图片间隙
heightinteger必须组件高度
listobject []必须图片列表

item 类型: object

├─ widthstring必须图片宽度
├─ heightstring必须图片高度
├─ leftstring必须图片左边距
├─ topstring必须图片上边距
├─ pic_urlstring必须图片地址
├─ linkobject必须具体见公共信息link
hotspotobject []必须热区列表

item 类型: object

├─ heightstring必须热区高度
├─ widthstring必须热区宽度
├─ leftstring必须热区左边距
├─ topstring必须热区上边距
├─ linkobject必须具体见公共信息link

地图

基本信息

Path: /map

Method: GET

接口描述:

补充diy页面接口的组件数据中id=map的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
locationstring必须定位地址(纬度,经度)
heightinteger必须地图高度
paddingYinteger必须组件上下内边距
paddingXinteger必须组件左右内边距
marginTopinteger必须组件顶部外边距
marginTopColorstring必须组件顶部外边距背景色
backgroundColorstring必须组件背景色
backgroundPicUrlstring必须组件背景图片
latitudestring必须纬度
longitudestring必须经度

好店推荐

基本信息

Path: /mch

Method: GET

接口描述:

补充diy页面接口的组件数据中id=mch的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
showGoodsboolean必须是否显示商品
listobject []必须店铺列表

item 类型: object

├─ idstring必须店铺id
├─ namestring必须店铺名称
├─ picUrlstring必须展示图
├─ goodsNumstring必须商品数量
├─ orderNumstring必须订单数量
├─ goodsListobject []必须商品列表

item 类型: object

├─ idstring必须商品id
├─ namestring必须商品名称
├─ picUrlstring必须商品图片
├─ pricestring必须商品售价
├─ showGoodsNuminteger必须显示商品数量
├─ staticGoodsboolean必须是否自定义商品
├─ pic_urlstring必须展示图
├─ goods_numstring必须商品数量
├─ longitudestring必须经度
├─ latitudestring必须纬度

导航图标

基本信息

Path: /nav

Method: GET

接口描述:

补充diy页面接口的组件数据中id=nav的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
backgroundstring必须背景色
colorstring必须文字颜色
rowsinteger必须每页显示行数
columnsinteger必须每行显示个数
scrollboolean必须是否左右滑动
navsobject []必须导航图标列表

item 类型: object

├─ iconstring必须图标地址
├─ namestring必须名称
├─ openTypestring必须链接类型
├─ urlstring必须链接路由
├─ icon_urlstring必须图标地址
├─ link_urlstring必须链接路由
├─ open_typestring必须链接类型

幸运抽奖

基本信息

Path: /lottery

Method: GET

接口描述:

补充diy页面接口的组件数据中id=lottery的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
buttonColorstring必须购买文字按钮颜色
listobject []必须商品列表

item 类型: object

├─ idinteger必须商品id
├─ goods_warehouse_idinteger必须商品库id
├─ mch_idinteger必须商品所属商户id
├─ signstring必须商品所属插件标示
├─ namestring必须商品名称
├─ cover_picstring必须缩略图
├─ original_pricenumber必须原价
├─ unitstring必须单位
├─ page_urlstring必须商品详情路径
├─ is_levelinteger必须是否享受会员价

枚举: 1,0

枚举备注: 1--享受 0--否

├─ level_pricenumber必须会员价
├─ pricenumber必须售价
├─ price_contentstring必须价格显示文本
├─ vip_card_appointobject必须超级会员卡
├─ discountstring必须折扣
├─ is_my_vip_card_goodsinteger必须登录用户是否享受商品折扣
├─ is_vip_card_userinteger必须登录用户是不是会员
├─ start_timestring必须开始时间
├─ end_timestring必须结束时间
listStyleinteger必须列表样式

枚举: -1,1

枚举备注: -1--列表模式 1--一行一个 2--一行两个

fillinteger必须封面图填充方式

枚举: 1,0

枚举备注: 1--填充 0--留白

goodsCoverProportionstring必须封面图宽高比例仅在listStyle=1是有效

枚举: 1-1,3-2

枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2

goodsStyleinteger必须单品样式

枚举: 1,2,3

枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中

showGoodsNameboolean必须是否显示商品名称
showBuyBtnboolean必须是否显示购买按钮
buyBtnStyleinteger必须购买按钮样式

枚举: 1,2,3

枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条

buyBtnTextstring必须购买按钮文本
showGoodsTagboolean必须是否显示角标
customizeGoodsTagboolean必须是否自定义角标
goodsTagPicUrlstring必须角标图片地址

弹窗广告

基本信息

Path: /modal

Method: GET

接口描述:

补充diy页面接口的组件数据中id=modal的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
openedboolean必须是否开启弹窗广告
listarray []必须列表

item 类型: array

├─ 非必须
├─ picUrlstring必须图片
├─ linkobject必须具体参考公共信息link
timesinteger必须弹窗次数

枚举: 1,0

枚举备注: 1--仅首次 0--每次

微信公众号

基本信息

Path: /mp-link

Method: GET

接口描述:

补充diy页面接口的组件数据中id=mp-link的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
positionstring必须组件位置

枚举: auto,top

枚举备注: auto--默认位置 top--固定悬浮在顶部

快捷导航

基本信息

Path: /quick-nav

Method: GET

接口描述:

补充diy页面接口的组件数据中id=quick-nav的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
closedPicUrlstring必须关闭导航图片 仅在navStyle=1时有效
openedPicUrlstring必须点击展开导航的图片 仅在navStyle=1时有效
navStyleinteger必须导航样式

枚举: 1

枚举备注: 1--样式一(点击收起) 2--样式二(全部展示)

navSwitchinteger必须组件开关

枚举: 1,0

枚举备注: 1--开启 0--关闭

useMallConfigboolean必须是否使用商城配置
customerServiceobject必须小程序自带的客户
├─ picUrlstring必须图片地址
├─ openedinteger必须是否开启

枚举: 1

枚举备注: 1--开启 0--关闭

homeobject必须返回首页
├─ openedinteger必须是否开启
├─ picUrlstring必须图片地址
mAppobject必须跳转小程序
├─ openedinteger必须是否开启
├─ small_app_idstring必须小程序appid
├─ small_app_urlstring必须小程序路径
├─ small_app_picstring必须图片地址
mapNavobject必须
├─ openedinteger必须是否开启
├─ picUrlstring必须图片地址
├─ addressstring必须详细地址
├─ latitudestring必须纬度
├─ longitudestring必须经度
telobject必须一键拨号
├─ openedinteger必须是否开启
├─ picUrlstring必须图片地址
├─ numberstring必须电话号码
webobject必须跳转外链
├─ openedstring必须是否开启
├─ picUrlstring必须图片地址
├─ urlstring必须外链地址

拼团

基本信息

Path: /pintuan

Method: GET

接口描述:

补充diy页面接口的组件数据中id=pintuan的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
buttonColorstring必须购买文字按钮颜色
listobject []必须商品列表

item 类型: object

├─ idinteger必须商品id
├─ goods_warehouse_idinteger必须商品库id
├─ mch_idinteger必须商品所属商户id
├─ signstring必须商品所属插件标示
├─ namestring必须商品名称
├─ cover_picstring必须缩略图
├─ original_pricenumber必须原价
├─ unitstring必须单位
├─ page_urlstring必须商品详情路径
├─ is_levelinteger必须是否享受会员价

枚举: 1,0

枚举备注: 1--享受 0--否

├─ level_pricenumber必须会员价
├─ pricenumber必须售价
├─ price_contentstring必须价格显示文本
├─ vip_card_appointobject必须超级会员卡
├─ discountstring必须折扣
├─ is_my_vip_card_goodsinteger必须登录用户是否享受商品折扣
├─ is_vip_card_userinteger必须登录用户是不是会员
├─ people_numstring必须拼团人数
├─ pintuan_pricestring必须拼团价格
listStyleinteger必须列表样式

枚举: -1,1

枚举备注: -1--列表模式 1--一行一个 2--一行两个

fillinteger必须封面图填充方式

枚举: 1,0

枚举备注: 1--填充 0--留白

goodsCoverProportionstring必须封面图宽高比例仅在listStyle=1是有效

枚举: 1-1,3-2

枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2

goodsStyleinteger必须单品样式

枚举: 1,2,3

枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中

showGoodsNameboolean必须是否显示商品名称
showBuyBtnboolean必须是否显示购买按钮
buyBtnStyleinteger必须购买按钮样式

枚举: 1,2,3

枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条

buyBtnTextstring必须购买按钮文本
showGoodsTagboolean必须是否显示角标
customizeGoodsTagboolean必须是否自定义角标
goodsTagPicUrlstring必须角标图片地址

优惠券

基本信息

Path: /coupon

Method: GET

接口描述:

补充diy页面接口的组件数据中id=coupon的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
textColorstring必须文字颜色
receiveBgstring必须已领取背景图
unclaimedBgstring必须未领取背景图
coupon_listobject []必须优惠券列表

item 类型: object

├─ idinteger必须优惠券id
├─ namestring必须优惠券名称
├─ typeinteger必须优惠券类型

枚举: 1,2

枚举备注: 1--折扣券 2--满减券

├─ discountnumber必须折扣率仅在type=1时有效
├─ discount_limitnumber必须最大优惠金额仅在type=1时有效
├─ min_pricenumber必须最低消费金额仅在type=2是有效
├─ sub_pricenumber必须减免金额仅在type=2时有效
├─ total_countinteger必须剩余可领取数量(-1表示没限制)
├─ sortinteger必须排序按升序
├─ expire_typeinteger必须有效期类型

枚举: 1

枚举备注: 1--*领取后N天内有效 2--一段时间内有效

├─ expire_dayinteger必须有效天数仅在expire_type=1时有效
├─ begin_timestring必须有效期开始时间仅在expire_type=2时有效
├─ end_timestring必须有效期结束时间仅在expire_type=2时有效
├─ appoint_typeinteger必须优惠范围

枚举: 1,2,3

枚举备注: 1--指定分类 2--指定商品 3--全场通用 4--仅用于当面付

├─ rulestring必须优惠券说明
├─ is_memberstring必须领取方式:是否会员专享

枚举: 1,0

枚举备注: 1--是 0--否

├─ is_receiveinteger必须用户领取数量

流量主

基本信息

Path: /ad

Method: GET

接口描述:

补充diy页面接口的组件数据中id=ad的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
idstring必须流量主id(微信)

版权

基本信息

Path: /copyright

Method: GET

接口描述:

补充diy页面接口的组件数据中id=copyright的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
picUrlstring必须图片地址
textstring必须版权文本
linkobject必须具体参考公共信息link
backgroundColorstring必须背景色

用户信息

基本信息

Path: /user-info

Method: GET

接口描述:

补充diy页面接口的组件数据中id=user-info的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
styleinteger必须样式

枚举: 1,2,3

枚举备注: 1--头像靠左 2--头像居中 3--头像内嵌

backgroundPicUrlstring必须背景图
backgroundColorstring必须背景色仅在style=3时有效

砍价

基本信息

Path: /bargain

Method: GET

接口描述:

补充diy页面接口的组件数据中id=bargain的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
buttonColorstring必须购买文字按钮颜色
listobject []必须商品列表

item 类型: object

├─ idinteger必须商品id
├─ goods_warehouse_idinteger必须商品库id
├─ mch_idinteger必须商品所属商户id
├─ signstring必须商品所属插件标示
├─ namestring必须商品名称
├─ cover_picstring必须缩略图
├─ original_pricenumber必须原价
├─ unitstring必须单位
├─ page_urlstring必须商品详情路径
├─ is_levelinteger必须是否享受会员价

枚举: 1,0

枚举备注: 1--享受 0--否

├─ level_pricenumber必须会员价
├─ pricenumber必须售价
├─ price_contentstring必须价格显示文本
├─ vip_card_appointobject必须超级会员卡
├─ discountstring必须折扣
├─ is_my_vip_card_goodsinteger必须登录用户是否享受商品折扣
├─ is_vip_card_userinteger必须登录用户是不是会员
├─ start_timestring必须开始时间
├─ end_timestring必须结束时间
listStyleinteger必须列表样式

枚举: -1,1

枚举备注: -1--列表模式 1--一行一个 2--一行两个

fillinteger必须封面图填充方式

枚举: 1,0

枚举备注: 1--填充 0--留白

goodsCoverProportionstring必须封面图宽高比例仅在listStyle=1是有效

枚举: 1-1,3-2

枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2

goodsStyleinteger必须单品样式

枚举: 1,2,3

枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中

showGoodsNameboolean必须是否显示商品名称
showBuyBtnboolean必须是否显示购买按钮
buyBtnStyleinteger必须购买按钮样式

枚举: 1,2,3

枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条

buyBtnTextstring必须购买按钮文本
showGoodsTagboolean必须是否显示角标
customizeGoodsTagboolean必须是否自定义角标
goodsTagPicUrlstring必须角标图片地址

秒杀

基本信息

Path: /miaosha

Method: GET

接口描述:

补充diy页面接口的组件数据中id=miaosha的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
buttonColorstring必须购买文字按钮颜色
listobject []必须商品列表

item 类型: object

├─ idinteger必须商品id
├─ goods_warehouse_idinteger必须商品库id
├─ mch_idinteger必须商品所属商户id
├─ signstring必须商品所属插件标示
├─ namestring必须商品名称
├─ cover_picstring必须缩略图
├─ original_pricenumber必须原价
├─ unitstring必须单位
├─ page_urlstring必须商品详情路径
├─ is_levelinteger必须是否享受会员价

枚举: 1,0

枚举备注: 1--享受 0--否

├─ level_pricenumber必须会员价
├─ pricenumber必须售价
├─ price_contentstring必须价格显示文本
├─ vip_card_appointobject必须超级会员卡
├─ discountstring必须折扣
├─ is_my_vip_card_goodsinteger必须登录用户是否享受商品折扣
├─ is_vip_card_userinteger必须登录用户是不是会员
├─ start_timestring必须开始时间
├─ end_timestring必须结束时间
listStyleinteger必须列表样式

枚举: -1,1

枚举备注: -1--列表模式 1--一行一个 2--一行两个

fillinteger必须封面图填充方式

枚举: 1,0

枚举备注: 1--填充 0--留白

goodsCoverProportionstring必须封面图宽高比例仅在listStyle=1是有效

枚举: 1-1,3-2

枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2

goodsStyleinteger必须单品样式

枚举: 1,2,3

枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中

showGoodsNameboolean必须是否显示商品名称
showBuyBtnboolean必须是否显示购买按钮
buyBtnStyleinteger必须购买按钮样式

枚举: 1,2,3

枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条

buyBtnTextstring必须购买按钮文本
showGoodsTagboolean必须是否显示角标
customizeGoodsTagboolean必须是否自定义角标
goodsTagPicUrlstring必须角标图片地址

积分商城

基本信息

Path: /integral-mall

Method: GET

接口描述:

补充diy页面接口的组件数据中id=integral-mall的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
buttonColorstring必须购买文字按钮颜色
showCouponboolean必须是否显示优惠券
couponPicUrlstring必须优惠券背景图
coupon_listobject []必须优惠券列表

item 类型: object

├─ idinteger必须优惠券id
├─ namestring必须优惠券名称
├─ typeinteger必须优惠券类型

枚举: 1

枚举备注: 1--折扣券 2--满减券

├─ discountstring必须折扣率 仅在type=1时有效
├─ discount_limitstring必须最多抵扣 仅在type=1时有效
├─ min_pricenumber必须最低消费 仅在type=2时有效
├─ sub_pricenumber必须减免金额 仅在type=2时有效
├─ total_countinteger必须剩余数量(-1表示无限制)
├─ expire_typeinteger必须有效期类型

枚举: 1

枚举备注: 1--领取后N天内有效 2--一段时间内有效

├─ expire_dayinteger必须有效天数 仅在expire_type=1时有效
├─ begin_timestring必须有效期开始时间 仅在expire_type=2时有效
├─ end_timestring必须有效期结束时间 仅在expire_type=2时有效
├─ appoint_typeinteger必须优惠范围

枚举: 1,2,3

枚举备注: 1--指定分类 2--指定商品 3--全场通用 4--仅用于当面付

├─ page_urlstring必须优惠券详情路径
showGoodsboolean必须是否显示商品
listobject []必须商品列表

item 类型: object

├─ idinteger必须商品id
├─ goods_warehouse_idinteger必须商品库id
├─ mch_idinteger必须商品所属商户id
├─ signstring必须商品所属插件标示
├─ namestring必须商品名称
├─ cover_picstring必须缩略图
├─ original_pricenumber必须原价
├─ unitstring必须单位
├─ page_urlstring必须商品详情路径
├─ is_levelinteger必须是否享受会员价

枚举: 1,0

枚举备注: 1--享受 0--否

├─ level_pricenumber必须会员价
├─ pricenumber必须售价
├─ price_contentstring必须价格显示文本
├─ vip_card_appointobject必须超级会员卡
├─ discountstring必须折扣
├─ is_my_vip_card_goodsinteger必须登录用户是否享受商品折扣
├─ is_vip_card_userinteger必须登录用户是不是会员
listStyleinteger必须列表样式

枚举: -1,1

枚举备注: -1--列表模式 1--一行一个 2--一行两个

fillinteger必须封面图填充方式

枚举: 1,0

枚举备注: 1--填充 0--留白

goodsCoverProportionstring必须封面图宽高比例仅在listStyle=1是有效

枚举: 1-1,3-2

枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2

goodsStyleinteger必须单品样式

枚举: 1,2,3

枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中

showGoodsNameboolean必须是否显示商品名称
showBuyBtnboolean必须是否显示购买按钮
buyBtnStyleinteger必须购买按钮样式

枚举: 1,2,3

枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条

buyBtnTextstring必须购买按钮文本
showGoodsTagboolean必须是否显示角标
customizeGoodsTagboolean必须是否自定义角标
goodsTagPicUrlstring必须角标图片地址

空白快

基本信息

Path: /empty

Method: GET

接口描述:

补充diy页面接口的组件数据中id=empty的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
backgroundstring必须背景色
heightinteger必须高度

签到

基本信息

Path: /check-in

Method: GET

接口描述:

补充diy页面接口的组件数据中id=check-in的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
backgroundPicUrlstring必须背景图片
showTextboolean必须是否展示文本
textPositionstring必须文本位置

枚举: left,center,right

枚举备注: left--靠左 center--居中 right--靠右

textColorstring必须文本颜色
hotspotobject必须热区
├─ heightinteger必须热区高度
├─ widthinteger必须热区宽度
├─ leftinteger必须热区左边距
├─ topinteger必须热区上边距
├─ is_closeboolean必须是否关闭
awardobject必须
├─ continueinteger必须连续签到天数
├─ numbernumber必须奖励数量
├─ typestring必须奖励类型

枚举: integral,balance

枚举备注: integral--积分 balance--余额

自定义表单

基本信息

Path: /form

Method: GET

接口描述:

补充diy页面接口的组件数据中id=form的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
styleinteger必须

枚举: 1,2,3

枚举备注: 1--样式一 2--样式二 3--样式三

heightinteger必须
inputPaddinginteger必须
marginBottominteger必须
radiusinteger必须
typeinteger必须
timesinteger必须

视频

基本信息

Path: /video

Method: GET

接口描述:

补充diy页面接口的组件数据中id=video的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
pic_urlstring必须视频封面图
urlstring必须视频地址

订单入口

基本信息

Path: /user-order

Method: GET

接口描述:

补充diy页面接口的组件数据中id=user-order的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
navsobject []必须图标列表

item 类型: object

├─ urlstring必须链接路由
├─ openTypestring必须链接类型
├─ picUrlstring必须图标地址
├─ textstring必须图标文本
├─ numstring必须显示数量
├─ open_typestring必须链接类型
├─ link_urlstring必须链接路由
├─ namestring必须显示文本
├─ icon_urlstring必须显示图标地址
backgroundColorstring必须组件背景色

超级会员卡

基本信息

Path: /vip-card

Method: GET

接口描述:

补充diy页面接口的组件数据中id=vip-card的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
buy_bgstring非必须未购买用户背景图
renew_bgstring非必须已购买用户背景图
buy_big_colorstring非必须未购买用户大标题颜色
buy_small_colorstring非必须未购买用户小标题颜色
buy_btn_colorstring非必须未购买用户按钮颜色
buy_btn_bg_colorstring非必须未购买用户按钮背景颜色
buy_bigstring非必须未购买用户大标题
buy_smallstring非必须未购买用户小标题
buy_btn_textstring非必须未购买用户按钮文字
renew_text_colorstring非必须已购买用户文字颜色
renew_btn_bg_colorstring非必须已购买用户按钮北京颜色
renew_textstring非必须已购买用户文字
usePluginConfigboolean非必须
backgroundstring非必须背景色
top_bottom_paddingnumber非必须

轮播图

基本信息

Path: /banner

Method: GET

接口描述:

补充diy页面接口的组件数据中id=banner的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
styleinteger必须样式

枚举: 1,2

枚举备注: 1--普通样式 2--卡片样式

fillinteger必须填充方式

枚举: 1

枚举备注: 1--填充 0--留白

heightinteger必须高度
bannersobject []必须列表

item 类型: object

├─ picUrlstring必须图片地址
├─ openTypestring必须链接类型
├─ urlstring必须链接路由
├─ paramsobject []必须具体参考公共信息

item 类型: object

├─ page_urlstring必须链接路由
├─ open_typestring必须链接类型
├─ pic_urlstring必须图片地址

门店

基本信息

Path: /store

Method: GET

接口描述:

补充diy页面接口的组件数据中id=store的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
navPicUrlstring必须导航图标
scorePicUrlstring必须评分图标
showNameboolean必须是否展示名称
showScoreboolean必须是否展示评分
showTelboolean必须是否展示电话
listobject []必须

item 类型: object

├─ idinteger必须门店id
├─ mobilestring必须联系方式
├─ namestring必须名称
├─ pic_urlstring必须封面图
├─ scoreinteger必须评分
├─ longitudestring必须经度
├─ latitudestring必须纬度

预售

基本信息

Path: /advance

Method: GET

接口描述:

补充diy页面接口的组件数据中id=advance的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
buttonColorstring必须购买文字按钮颜色
listobject []必须商品列表

item 类型: object

├─ idinteger必须商品id
├─ goods_warehouse_idinteger必须商品库id
├─ mch_idinteger必须商品所属商户id
├─ signstring必须商品所属插件标示
├─ namestring必须商品名称
├─ cover_picstring必须缩略图
├─ original_pricenumber必须原价
├─ unitstring必须单位
├─ page_urlstring必须商品详情路径
├─ is_levelinteger必须是否享受会员价

枚举: 1,0

枚举备注: 1--享受 0--否

├─ level_pricenumber必须会员价
├─ pricenumber必须售价
├─ price_contentstring必须价格显示文本
├─ vip_card_appointobject必须超级会员卡
├─ discountstring必须折扣
├─ is_my_vip_card_goodsinteger必须登录用户是否享受商品折扣
├─ is_vip_card_userinteger必须登录用户是不是会员
listStyleinteger必须列表样式

枚举: -1,1

枚举备注: -1--列表模式 1--一行一个 2--一行两个

fillinteger必须封面图填充方式

枚举: 1,0

枚举备注: 1--填充 0--留白

goodsCoverProportionstring必须封面图宽高比例仅在listStyle=1是有效

枚举: 1-1,3-2

枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2

goodsStyleinteger必须单品样式

枚举: 1,2,3

枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中

showGoodsNameboolean必须是否显示商品名称
showBuyBtnboolean必须是否显示购买按钮
buyBtnStyleinteger必须购买按钮样式

枚举: 1,2,3

枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条

buyBtnTextstring必须购买按钮文本
showGoodsTagboolean必须是否显示角标
customizeGoodsTagboolean必须是否自定义角标
goodsTagPicUrlstring必须角标图片地址

预约

基本信息

Path: /booking

Method: GET

接口描述:

补充diy页面接口的组件数据中id=booking的

请求参数

返回数据

名称类型是否必须默认值备注其他信息
buttonColorstring必须购买文字按钮颜色
listobject []必须商品列表

item 类型: object

├─ idinteger必须商品id
├─ goods_warehouse_idinteger必须商品库id
├─ mch_idinteger必须商品所属商户id
├─ signstring必须商品所属插件标示
├─ namestring必须商品名称
├─ cover_picstring必须缩略图
├─ original_pricenumber必须原价
├─ unitstring必须单位
├─ page_urlstring必须商品详情路径
├─ is_levelinteger必须是否享受会员价

枚举: 1,0

枚举备注: 1--享受 0--否

├─ level_pricenumber必须会员价
├─ pricenumber必须售价
├─ price_contentstring必须价格显示文本
├─ vip_card_appointobject必须超级会员卡
├─ discountstring必须折扣
├─ is_my_vip_card_goodsinteger必须登录用户是否享受商品折扣
├─ is_vip_card_userinteger必须登录用户是不是会员
listStyleinteger必须列表样式

枚举: -1,1

枚举备注: -1--列表模式 1--一行一个 2--一行两个

fillinteger必须封面图填充方式

枚举: 1,0

枚举备注: 1--填充 0--留白

goodsCoverProportionstring必须封面图宽高比例仅在listStyle=1是有效

枚举: 1-1,3-2

枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2

goodsStyleinteger必须单品样式

枚举: 1,2,3

枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中

showGoodsNameboolean必须是否显示商品名称
showBuyBtnboolean必须是否显示购买按钮
buyBtnStyleinteger必须购买按钮样式

枚举: 1,2,3

枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条

buyBtnTextstring必须购买按钮文本
showGoodsTagboolean必须是否显示角标
customizeGoodsTagboolean必须是否自定义角标
goodsTagPicUrlstring必须角标图片地址

订单管理

订单列表

基本信息

Path: /api/order/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 0 0.全部

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须订单ID
├─ mall_idnumber必须商城ID
├─ user_idnumber必须用户ID
├─ mch_idnumber必须商户ID
├─ order_nostring必须订单号
├─ total_pricestring必须订单总金额(含运费)
├─ total_pay_pricestring必须实际支付总费用(含运费)
├─ express_original_pricestring必须运费(后台修改前)
├─ express_pricestring必须运费(后台修改后)
├─ total_goods_pricestring必须订单商品总金额(优惠后)
├─ total_goods_original_pricestring必须订单商品总金额(优惠前)
├─ member_discount_pricestring必须会员优惠价格(正数表示优惠,负数表示加价)
├─ use_user_coupon_idnumber必须使用的用户优惠券id
├─ coupon_discount_pricestring必须优惠券优惠金额
├─ use_integral_numnumber必须使用积分数量
├─ integral_deduction_pricestring必须积分抵扣金额
├─ namestring必须收件人姓名
├─ mobilestring必须收件人手机号
├─ addressstring必须收件人地址
├─ remarkstring必须用户订单备注
├─ order_formobject []必须自定义表单(JSON)

item 类型: object

├─ keystring必须表单组件唯一标识
├─ labelstring必须表单名称
├─ valuestring,null必须表单值
├─ requirednumber必须表单组件是否必填
├─ wordsstring必须商家留言
├─ seller_remarkstring必须商家订单备注
├─ is_paynumber必须是否支付:0.未支付|1.已支付
├─ pay_typenumber必须支付方式:1.在线支付 2.货到付款 3.余额支付
├─ pay_timestring必须支付时间
├─ is_sendnumber必须是否发货:0.未发货|1.已发货
├─ send_timestring必须发货时间
├─ customer_namestring必须(已废弃)京东商家编号
├─ expressstring必须(已废弃)物流公司
├─ express_nostring必须(已废弃)物流订单号
├─ is_salenumber必须是否过售后时间
├─ is_confirmnumber必须收货状态:0.未收货|1.已收货
├─ confirm_timestring必须确认收货时间
├─ cancel_statusnumber必须订单取消状态:0.未取消|1.已取消|2.申请取消
├─ cancel_timestring必须订单取消时间
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ is_recyclenumber必须是否加入回收站 0.否|1.是
├─ send_typenumber必须是否到店自提:0.否|1.是
├─ offline_qrcodestring必须核销码
├─ clerk_idnumber必须核销员ID
├─ store_idnumber必须自提门店ID
├─ signstring必须订单标识,用于区分插件
├─ tokenstring必须订单所属队列标识
├─ support_pay_typesstring必须支持的支付方式,空表示支持系统设置支持的所有方式
├─ is_commentnumber必须是否评价0.否|1.是
├─ comment_timestring必须评价时间
├─ sale_statusnumber必须是否申请售后0.否|1.是
├─ statusnumber必须订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_pricestring必须后台优惠(正数表示优惠,负数表示加价)
├─ auto_cancel_timestring必须自动取消时间
├─ auto_confirm_timenull,string必须自动确认收货时间
├─ auto_sales_timenull,string必须自动售后时间
├─ distancenumber必须同城配送距离,-1不在范围内,正数为距离KM
├─ city_mobilestring必须同城配送联系方式
├─ locationnull必须同城配送用户经纬度
├─ city_namenull必须城市名称
├─ city_infonull必须城市信息
├─ commentsstring []必须订单评价,用于判断订单是否已评价

item 类型: string

├─ 非必须
├─ detailobject []必须

item 类型: object

├─ idnumber必须商品详情ID
├─ order_idnumber必须关联订单ID
├─ goods_idnumber必须商品ID
├─ numnumber必须商品数量
├─ unit_pricestring必须商品单价
├─ total_original_pricestring必须商品原总价(优惠前)
├─ total_pricestring必须商品总价(优惠后)
├─ member_discount_pricestring必须会员优惠金额(正数表示优惠,负数表示加价)
├─ goods_infoobject必须商品信息josn格式
├─ namestring非必须商品名称
├─ attr_listobject []非必须已选规格信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ pic_urlstring非必须商品缩略图
├─ numnumber非必须商品数量
├─ total_original_pricestring非必须商品总价(优惠前)
├─ member_discount_pricestring非必须会员折扣金额
├─ is_deletenumber必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_refundnumber必须商品是否退款
├─ refund_statusnumber必须售后状态 0--未售后 1--售后中 2--售后结束
├─ back_pricestring必须售后状态 0--未售后 1--售后中 2--售后结束
├─ signstring必须订单详情标识,用于区分插件
├─ goods_nostring必须商品货号
├─ status_textstring必须订单状态(汉字)
├─ is_offlinenumber必须发货方式,兼容版本,该字段与send_type相同
├─ detailExpressobject []必须订单快递发货信息

item 类型: object

├─ idnumber非必须订单物流ID
├─ mall_idnumber非必须商城ID
├─ mch_idnumber非必须商户ID,大于0则表示为商户
├─ order_idnumber非必须订单ID
├─ expressstring非必须物流公司
├─ send_typenumber非必须发货类型1.快递|2.其它方式
├─ express_nostring非必须物流订单号
├─ merchant_remarkstring非必须商家留言
├─ express_contentstring非必须物流内容
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ expressRelationobject []非必须物流信息关联商品详情

item 类型: object

├─ idnumber非必须
├─ mall_idnumber非必须商城ID
├─ mch_idnumber非必须商户ID
├─ order_idnumber非必须订单ID
├─ order_detail_idnumber非必须订单详情ID
├─ order_detail_express_idnumber非必须关联物流详情ID
├─ is_deletenumber非必须
├─ orderDetailobject非必须订单详情,与detail相同
├─ idnumber非必须
├─ order_idnumber非必须
├─ goods_idnumber非必须
├─ numnumber非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infoobject非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ goods_attrobject非必须
├─ idnumber非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stocknumber非必须
├─ pricenumber非必须
├─ original_pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ share_commission_firststring非必须
├─ share_commission_secondstring非必须
├─ share_commission_thirdstring非必须
├─ individual_sharenumber非必须
├─ share_typenumber非必须
├─ member_pricenumber非必须
├─ integral_pricenull非必须
├─ use_integralnull非必须
├─ discountstring []非必须

item 类型: string

├─ 非必须
├─ extrastring []非必须

item 类型: string

├─ 非必须
├─ goods_warehouse_idnumber非必须
├─ namestring非必须
├─ cover_picstring非必须
├─ detailstring非必须
├─ pic_liststring非必须
├─ numbernumber非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_refundnumber非必须
├─ refund_statusnumber非必须
├─ back_pricestring非必须
├─ signstring非必须
├─ goods_nostring非必须
├─ der_infoobject []必须物流信息,注释与detailExpress.expressRelation相同

item 类型: object

├─ idnumber非必须
├─ mall_idnumber非必须
├─ mch_idnumber非必须
├─ order_idnumber非必须
├─ order_detail_idnumber非必须
├─ order_detail_express_idnumber非必须
├─ is_deletenumber非必须
├─ orderExpressobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ mch_idnumber非必须
├─ order_idnumber非必须
├─ expressstring非必须
├─ send_typenumber非必须
├─ express_nostring非必须
├─ merchant_remarkstring非必须
├─ express_contentstring非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

售后用户发货

基本信息

Path: /api/order/refund-send

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 400 售后订单ID
express text 是 顺风速运 快递公司名称
customer_name text 是 京东物流必须填写京东商家编码
express_no text 是 128398213912839 快递单号

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

售后订单详情

基本信息

Path: /api/order/refund-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 订单ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须售后订单ID
├─ mall_idnumber非必须商城ID
├─ mch_idnumber非必须商户ID
├─ user_idnumber非必须用户ID
├─ order_idnumber非必须关联订单ID
├─ order_detail_idnumber非必须关联订单详情ID
├─ order_nostring非必须售后订单号
├─ typenumber非必须售后类型:1=退货退款,2=换货
├─ refund_pricestring非必须退款金额
├─ remarkstring非必须用户退款备注、说明
├─ pic_liststring非必须用户上传图片凭证
├─ statusnumber非必须订单状态 1.待商家处理 2.同意 3.拒绝
├─ status_timestring非必须商家处理时间
├─ merchant_remarkstring非必须商家同意|拒绝备注、理由
├─ is_sendnumber非必须用户是否发货 0.未发货1.已发货
├─ send_timestring非必须发货时间
├─ customer_namestring非必须京东商家编号
├─ expressstring非必须快递公司
├─ express_nostring非必须快递单号
├─ address_idnumber非必须退换货地址ID
├─ is_confirmnumber非必须商家是否确认操作0.未确认|1.已确认
├─ confirm_timestring非必须确认时间
├─ is_refundnumber非必须退货退款时,是否退款
├─ refund_timestring非必须退款时间
├─ merchant_customer_namestring非必须换货-商家京东商家编号
├─ merchant_expressstring非必须换货-商家发货快递公司
├─ merchant_express_nostring非必须换货-商家发货快递单号
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ status_textstring非必须售后订单状态(中文)
├─ detailobject []非必须售后退款商品信息

item 类型: object

├─ goods_infoobject必须商品信息josn格式
├─ namestring非必须商品名称
├─ attr_listobject []非必须已选规格信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ pic_urlstring非必须商品缩略图
├─ numnumber非必须商品数量
├─ total_original_pricestring非必须商品总价(优惠前)
├─ member_discount_pricestring非必须会员折扣金额
├─ refundAddressobject非必须
├─ idnumber非必须商家收货地址ID
├─ mall_idnumber非必须商城ID
├─ mch_idnumber非必须商户ID
├─ namestring非必须收件人
├─ addressstring非必须收件地址
├─ address_detailstring非必须地址详情
├─ mobilestring非必须联系方式
├─ remarkstring非必须备注
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ express_listobject []非必须

item 类型: object

├─ idnumber必须快递公司ID
├─ namestring必须快递公司名称
├─ codestring必须快递公司标识

未付款订单支付

基本信息

Path: /api/order/list-pay-data

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 5827 订单ID

返回数据

名称类型是否必须默认值备注其他信息

核销订单确认收款

基本信息

Path: /api/order/clerk-affirm-pay

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 5797 订单ID
action_type 是 1 收款方式:1.小程序端确认收款

返回数据

名称类型是否必须默认值备注其他信息

物流公司列表

基本信息

Path: /api/order/express-list_

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须ID
├─ namestring必须物流公司名称
├─ codestring必须物流编码

生成售后订单

基本信息

Path: /api/order/refund-submit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 订单详情ID
type text 是 1 售后类型:1.退货退款
pic_list text 否 ["http://wxapp.mianke.me:2002/foal_store/web/uploads/mall195/20191115/c88b29dbfb1b348fa2cdd29048acf31e.png"] 上传凭证图片,一维数组
refund_price text 否 100 退款金额 type==1 时传入,退款金额不能大于订单支付金额
remark text 否 备注 备注

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

申请售后

基本信息

Path: /api/order/apply-refund

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 4843 订单详情ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须商品详情ID
├─ order_idnumber非必须关联订单ID
├─ goods_idnumber非必须商品ID
├─ numnumber非必须商品数量
├─ unit_pricestring非必须商品单价
├─ total_original_pricestring非必须商品原总价(优惠前)
├─ total_pricestring非必须商品总价(优惠后)
├─ member_discount_pricestring非必须会员优惠金额(正数表示优惠,负数表示加价)
├─ goods_infoobject非必须商品信息josn格式
├─ namestring非必须商品名称
├─ attr_listobject []非必须已选规格信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ pic_urlstring非必须商品缩略图
├─ numnumber非必须商品数量
├─ total_original_pricestring非必须商品总价(优惠前)
├─ member_discount_pricestring非必须会员折扣金额
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_refundnumber非必须商品是否退款
├─ refund_statusnumber非必须售后状态 0--未售后 1--售后中 2--售后结束
├─ back_pricestring非必须售后状态 0--未售后 1--售后中 2--售后结束
├─ signstring非必须订单详情标识,用于区分插件
├─ goods_nostring非必须商品货号
├─ orderobject非必须订单信息
├─ idnumber非必须订单ID
├─ mall_idnumber非必须商城ID
├─ user_idnumber非必须用户ID
├─ mch_idnumber非必须商户ID
├─ order_nostring非必须订单号
├─ total_pricestring非必须订单总金额(含运费)
├─ total_pay_pricestring非必须实际支付总费用(含运费)
├─ express_original_pricestring非必须运费(后台修改前)
├─ express_pricestring非必须运费(后台修改后)
├─ total_goods_pricestring非必须订单商品总金额(优惠后)
├─ total_goods_original_pricestring非必须订单商品总金额(优惠前)
├─ member_discount_pricestring非必须会员优惠价格(正数表示优惠,负数表示加价)
├─ use_user_coupon_idnumber非必须使用的用户优惠券id
├─ coupon_discount_pricestring非必须优惠券优惠金额
├─ use_integral_numnumber非必须使用积分数量
├─ integral_deduction_pricestring非必须积分抵扣金额
├─ namestring非必须收件人姓名
├─ mobilestring非必须收件人手机号
├─ addressstring非必须收件人地址
├─ remarkstring非必须用户订单备注
├─ order_formobject []非必须自定义表单(JSON)

item 类型: object

├─ keystring必须表单组件唯一标识
├─ labelstring必须表单名称
├─ valuestring,null必须表单值
├─ requirednumber必须表单组件是否必填
├─ wordsstring非必须商家留言
├─ seller_remarkstring非必须商家订单备注
├─ is_paynumber非必须是否支付:0.未支付|1.已支付
├─ pay_typenumber非必须支付方式:1.在线支付 2.货到付款 3.余额支付
├─ pay_timestring非必须支付时间
├─ is_sendnumber非必须是否发货:0.未发货|1.已发货
├─ send_timestring非必须发货时间
├─ customer_namestring非必须(已废弃)京东商家编号
├─ expressstring非必须(已废弃)物流公司
├─ express_nostring非必须(已废弃)物流订单号
├─ is_salenumber非必须是否过售后时间
├─ is_confirmnumber非必须收货状态:0.未收货|1.已收货
├─ confirm_timestring非必须确认收货时间
├─ cancel_statusnumber非必须订单取消状态:0.未取消|1.已取消|2.申请取消
├─ cancel_timestring非必须订单取消时间
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ is_recyclenumber非必须是否加入回收站 0.否|1.是
├─ send_typenumber非必须是否到店自提:0.否|1.是
├─ offline_qrcodestring非必须核销码
├─ clerk_idnumber非必须核销员ID
├─ store_idnumber非必须自提门店ID
├─ signstring非必须订单标识,用于区分插件
├─ tokenstring非必须订单所属队列标识
├─ support_pay_typesstring非必须支持的支付方式,空表示支持系统设置支持的所有方式
├─ is_commentnumber非必须是否评价0.否|1.是
├─ comment_timestring非必须评价时间
├─ sale_statusnumber非必须是否申请售后0.否|1.是
├─ statusnumber非必须订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_pricestring非必须后台优惠(正数表示优惠,负数表示加价)
├─ auto_cancel_timestring非必须自动取消时间
├─ auto_confirm_timenull,string非必须自动确认收货时间
├─ auto_sales_timenull,string非必须自动售后时间
├─ distancenumber非必须同城配送距离,-1不在范围内,正数为距离KM
├─ city_mobilestring非必须同城配送联系方式
├─ locationnull非必须同城配送用户经纬度
├─ city_namenull非必须城市名称
├─ city_infonull非必须城市信息
├─ goodsobject非必须商品信息
├─ idstring非必须商品ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ goods_warehouse_idstring非必须关联商品库ID
├─ statusstring非必须上架状态:0=下架,1=上架
├─ pricestring非必须售价
├─ use_attrstring非必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring非必须商品规格组
├─ goods_stockstring非必须商品总库存(规格库存相加)
├─ virtual_salesstring非必须已出售量(虚拟销量)
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模板ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否单独设置会员价
├─ share_typestring非必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring非必须商品标示用于区分商品属于什么模块
├─ app_share_picstring非必须商品自定义分享图片
├─ app_share_titlestring非必须商品自定义分享标题
├─ is_default_servicesstring非必须默认服务 0.否|1.是
├─ sortstring非必须商品排序
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须统计 支付人数
├─ payment_numstring非必须统计 支付件数
├─ payment_amountstring非必须统计 支付金额
├─ payment_orderstring非必须支付订单数
├─ confine_order_countstring非必须限制下单数量
├─ is_area_limitstring非必须是否单独区域购买
├─ area_limitstring非必须区域限制详情 json格式
├─ share_level_typestring非必须合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_idstring非必须自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ goodsWarehouseobject非必须商品库商品信息
├─ idstring非必须商品库商品ID
├─ mall_idstring非必须商城ID
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ cost_pricestring非必须成本价
├─ detailstring非必须商品详情json
├─ cover_picstring非必须商品缩略图
├─ pic_urlstring非必须商品轮播图
├─ video_urlstring非必须商品视频
├─ unitstring非必须商品单位
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ refund_pricestring非必须售后最多可退款金额

售后订单列表

基本信息

Path: /api/order/list_1573789146528

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 5 5.售后订单列表

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须售后订单ID
├─ mall_idnumber必须商城ID
├─ mch_idnumber必须商户ID
├─ user_idnumber必须用户ID
├─ order_idnumber必须关联订单ID
├─ order_detail_idnumber必须关联订单详情ID
├─ order_nostring必须售后订单号
├─ typenumber必须售后类型:1=退货退款,2=换货
├─ refund_pricestring必须退款金额
├─ remarkstring必须用户退款备注、说明
├─ pic_liststring必须用户上传图片凭证
├─ statusnumber必须1.待商家处理 2.同意 3.拒绝
├─ status_timestring必须商家处理时间
├─ merchant_remarkstring必须商家同意|拒绝备注、理由
├─ is_sendnumber必须用户是否发货 0.未发货1.已发货
├─ send_timestring必须发货时间
├─ customer_namestring必须京东商家编号
├─ expressstring必须快递公司
├─ express_nostring必须快递单号
├─ address_idnumber必须退换货地址ID
├─ is_confirmnumber必须商家是否确认操作0.未确认|1.已确认
├─ confirm_timestring必须确认时间
├─ is_refundnumber必须退货退款时,是否退款
├─ refund_timestring必须退款时间
├─ merchant_customer_namestring必须换货-商家京东商家编号
├─ merchant_expressstring必须换货-商家发货快递公司
├─ merchant_express_nostring必须换货-商家发货快递单号
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ status_textstring必须售后订单状态(中文)
├─ detailobject []必须售后退款商品信息

item 类型: object

├─ goods_infoobject必须商品信息josn格式
├─ namestring非必须商品名称
├─ attr_listobject []非必须已选规格信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ pic_urlstring非必须商品缩略图
├─ numnumber非必须商品数量
├─ total_original_pricestring非必须商品总价(优惠前)
├─ member_discount_pricestring非必须会员折扣金额
├─ reality_refund_pricestring必须商家实际退款金额
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

订单取消|申请取消

基本信息

Path: /api/order/cancel

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 5864 订单ID

返回数据

名称类型是否必须默认值备注其他信息

订单核销

基本信息

Path: /api/order/order-clerk

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 4284 订单ID
action_type 是 1 1.小程序端确认收款
clerk_remark 否 核销备注 核销备注

返回数据

名称类型是否必须默认值备注其他信息

订单核销码

基本信息

Path: /api/order/clerk-qr-code

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 4284 订单ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ file_pathstring非必须核销码链接

订单物流详情

基本信息

Path: /api/order/api/order/express-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
express 是 顺丰速运 快递公司
customer_name 是 京东商家编号,京东物流查询时需传入
express_no 是 288799311690 物流订单号

返回数据

名称类型是否必须默认值备注其他信息

订单确认收货

基本信息

Path: /api/order/confirm

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 5797 订单ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

订单评价

基本信息

Path: /api/order/appraise

Method: POST

接口描述:

appraiseData数组对象参数注释

id    订单详情ID
content    评价内容
pic_list    评价图片
grade_level    评分:1=差评,2=中评,3=好
is_anonymous    是否匿名评价 true|false

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 5827 订单ID

Body

参数名称 参数类型 是否必须 示例 备注
order_id text 是 5843 订单ID
appraiseData text 是 [{"id":"6007","content":"123","pic_list":["http://wxapp.mianke.me:2002/foal_store/web/uploads/mall195/20191116/739f2e632cb7b8b19642fe595a23ed45.png"],"grade_level":3,"is_anonymous":true}] 二维数组json格式,具体意思看接口备注

返回数据

名称类型是否必须默认值备注其他信息

订单详情

基本信息

Path: /api/order/detail

Method: GET

接口描述:

电子卡密插件---2020-03-19
新增字段:is_show_send_type、type_data、goods_type、is_show_express、is_can_apply_sales;

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 订单ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须订单ID
├─ mall_idnumber非必须商城ID
├─ user_idnumber非必须用户ID
├─ mch_idnumber非必须商户ID
├─ order_nostring非必须订单号
├─ total_pricestring非必须订单总金额(含运费)
├─ total_pay_pricestring非必须实际支付总费用(含运费)
├─ express_original_pricestring非必须运费(后台修改前)
├─ express_pricestring非必须运费(后台修改后)
├─ total_goods_pricestring非必须订单商品总金额(优惠后)
├─ total_goods_original_pricestring非必须订单商品总金额(优惠前)
├─ member_discount_pricestring非必须会员优惠价格(正数表示优惠,负数表示加价)
├─ use_user_coupon_idnumber非必须使用的用户优惠券id
├─ coupon_discount_pricestring非必须优惠券优惠金额
├─ use_integral_numnumber非必须使用积分数量
├─ integral_deduction_pricestring非必须积分抵扣金额
├─ namestring非必须收件人姓名
├─ mobilestring非必须收件人手机号
├─ addressstring非必须收件人地址
├─ remarkstring非必须用户订单备注
├─ order_formobject []非必须自定义表单(JSON)

item 类型: object

├─ keystring必须表单组件唯一标识
├─ labelstring必须表单名称
├─ valuestring,null必须表单值
├─ requirednumber必须表单组件是否必填
├─ wordsstring非必须商家留言
├─ seller_remarkstring非必须商家订单备注
├─ is_paynumber非必须是否支付:0.未支付|1.已支付
├─ pay_typenumber非必须支付方式:1.在线支付 2.货到付款 3.余额支付
├─ pay_timestring非必须支付时间
├─ is_sendnumber非必须是否发货:0.未发货|1.已发货
├─ send_timestring非必须发货时间
├─ customer_namestring非必须(已废弃)京东商家编号
├─ expressstring非必须(已废弃)物流公司
├─ express_nostring非必须(已废弃)物流订单号
├─ is_salenumber非必须是否过售后时间
├─ is_confirmnumber非必须收货状态:0.未收货|1.已收货
├─ confirm_timestring非必须确认收货时间
├─ cancel_statusnumber非必须订单取消状态:0.未取消|1.已取消|2.申请取消
├─ cancel_timestring非必须订单取消时间
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ is_recyclenumber非必须是否加入回收站 0.否|1.是
├─ send_typenumber非必须是否到店自提:0.否|1.是
├─ offline_qrcodestring非必须核销码
├─ clerk_idnumber非必须核销员ID
├─ store_idnumber非必须自提门店ID
├─ signstring非必须订单标识,用于区分插件
├─ tokenstring非必须订单所属队列标识
├─ support_pay_typesstring非必须支持的支付方式,空表示支持系统设置支持的所有方式
├─ is_commentnumber非必须是否评价0.否|1.是
├─ comment_timestring非必须评价时间
├─ sale_statusnumber非必须是否申请售后0.否|1.是
├─ statusnumber非必须订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_pricestring非必须后台优惠(正数表示优惠,负数表示加价)
├─ auto_cancel_timestring非必须自动取消时间
├─ auto_confirm_timenull,string非必须自动确认收货时间
├─ auto_sales_timenull,string非必须自动售后时间
├─ distancenumber非必须同城配送距离,-1不在范围内,正数为距离KM
├─ city_mobilestring非必须同城配送联系方式
├─ locationnull非必须同城配送用户经纬度
├─ city_namenull非必须城市名称
├─ city_infonull非必须城市信息
├─ detailobject []非必须

item 类型: object

├─ idnumber必须商品详情ID
├─ order_idnumber必须关联订单ID
├─ goods_idnumber必须商品ID
├─ numnumber必须商品数量
├─ unit_pricestring必须商品单价
├─ total_original_pricestring必须商品原总价(优惠前)
├─ total_pricestring必须商品总价(优惠后)
├─ member_discount_pricestring必须会员优惠金额(正数表示优惠,负数表示加价)
├─ goods_infoobject必须商品信息josn格式
├─ namestring非必须商品名称
├─ attr_listobject []非必须已选规格信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ pic_urlstring非必须商品缩略图
├─ numnumber非必须商品数量
├─ total_original_pricestring非必须商品总价(优惠前)
├─ member_discount_pricestring非必须会员折扣金额
├─ is_deletenumber必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_refundnumber必须商品是否退款
├─ refund_statusnumber必须售后状态 0--未售后 1--售后中 2--售后结束
├─ back_pricestring必须售后状态 0--未售后 1--售后中 2--售后结束
├─ signstring必须订单详情标识,用于区分插件
├─ goods_nostring必须商品货号
├─ orderobject必须
├─ idnumber非必须订单ID
├─ mall_idnumber非必须商城ID
├─ user_idnumber非必须用户ID
├─ mch_idnumber非必须商户ID
├─ order_nostring非必须订单号
├─ total_pricestring非必须订单总金额(含运费)
├─ total_pay_pricestring非必须实际支付总费用(含运费)
├─ express_original_pricestring非必须运费(后台修改前)
├─ express_pricestring非必须运费(后台修改后)
├─ total_goods_pricestring非必须订单商品总金额(优惠后)
├─ total_goods_original_pricestring非必须订单商品总金额(优惠前)
├─ member_discount_pricestring非必须会员优惠价格(正数表示优惠,负数表示加价)
├─ use_user_coupon_idnumber非必须使用的用户优惠券id
├─ coupon_discount_pricestring非必须优惠券优惠金额
├─ use_integral_numnumber非必须使用积分数量
├─ integral_deduction_pricestring非必须积分抵扣金额
├─ namestring非必须收件人姓名
├─ mobilestring非必须收件人手机号
├─ addressstring非必须收件人地址
├─ remarkstring非必须用户订单备注
├─ order_formobject []非必须自定义表单(JSON)

item 类型: object

├─ keystring必须表单组件唯一标识
├─ labelstring必须表单名称
├─ valuestring,null必须表单值
├─ requirednumber必须表单组件是否必填
├─ wordsstring非必须商家留言
├─ seller_remarkstring非必须商家订单备注
├─ is_paynumber非必须是否支付:0.未支付|1.已支付
├─ pay_typenumber非必须支付方式:1.在线支付 2.货到付款 3.余额支付
├─ pay_timestring非必须支付时间
├─ is_sendnumber非必须是否发货:0.未发货|1.已发货
├─ send_timestring非必须发货时间
├─ customer_namestring非必须(已废弃)京东商家编号
├─ expressstring非必须(已废弃)物流公司
├─ express_nostring非必须(已废弃)物流订单号
├─ is_salenumber非必须是否过售后时间
├─ is_confirmnumber非必须收货状态:0.未收货|1.已收货
├─ confirm_timestring非必须确认收货时间
├─ cancel_statusnumber非必须订单取消状态:0.未取消|1.已取消|2.申请取消
├─ cancel_timestring非必须订单取消时间
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ is_recyclenumber非必须是否加入回收站 0.否|1.是
├─ send_typenumber非必须是否到店自提:0.否|1.是
├─ offline_qrcodestring非必须核销码
├─ clerk_idnumber非必须核销员ID
├─ store_idnumber非必须自提门店ID
├─ signstring非必须订单标识,用于区分插件
├─ tokenstring非必须订单所属队列标识
├─ support_pay_typesstring非必须支持的支付方式,空表示支持系统设置支持的所有方式
├─ is_commentnumber非必须是否评价0.否|1.是
├─ comment_timestring非必须评价时间
├─ sale_statusnumber非必须是否申请售后0.否|1.是
├─ statusnumber非必须订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_pricestring非必须后台优惠(正数表示优惠,负数表示加价)
├─ auto_cancel_timestring非必须自动取消时间
├─ auto_confirm_timenull,string非必须自动确认收货时间
├─ auto_sales_timenull,string非必须自动售后时间
├─ distancenumber非必须同城配送距离,-1不在范围内,正数为距离KM
├─ city_mobilestring非必须同城配送联系方式
├─ locationnull非必须同城配送用户经纬度
├─ city_namenull非必须城市名称
├─ city_infonull非必须城市信息
├─ goodsobject必须
├─ idstring非必须商品ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ goods_warehouse_idstring非必须关联商品库ID
├─ statusstring非必须上架状态:0=下架,1=上架
├─ pricestring非必须售价
├─ use_attrstring非必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring非必须商品规格组
├─ goods_stockstring非必须商品总库存(规格库存相加)
├─ virtual_salesstring非必须已出售量(虚拟销量)
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模板ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否单独设置会员价
├─ share_typestring非必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring非必须商品标示用于区分商品属于什么模块
├─ app_share_picstring非必须商品自定义分享图片
├─ app_share_titlestring非必须商品自定义分享标题
├─ is_default_servicesstring非必须默认服务 0.否|1.是
├─ sortstring非必须商品排序
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须统计 支付人数
├─ payment_numstring非必须统计 支付件数
├─ payment_amountstring非必须统计 支付金额
├─ payment_orderstring非必须支付订单数
├─ confine_order_countstring非必须限制下单数量
├─ is_area_limitstring非必须是否单独区域购买
├─ area_limitstring非必须区域限制详情 json格式
├─ share_level_typestring非必须合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_idstring非必须自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ goodsWarehouseobject非必须商品库商品信息
├─ idstring非必须商品库商品ID
├─ mall_idstring非必须商城ID
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ cost_pricestring非必须成本价
├─ detailstring非必须商品详情json
├─ cover_picstring非必须商品缩略图
├─ pic_urlstring非必须商品轮播图
├─ video_urlstring非必须商品视频
├─ unitstring非必须商品单位
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ refundnull必须是否退款0.否|1.是
├─ storenull非必须自提门店信息
├─ detailExpressobject []非必须

item 类型: object

├─ idnumber必须订单物流ID
├─ mall_idnumber必须商城ID
├─ mch_idnumber必须商户ID,大于0则表示为商户
├─ order_idnumber必须订单ID
├─ expressstring必须物流公司
├─ send_typenumber必须发货类型1.快递|2.其它方式
├─ express_nostring必须物流订单号
├─ merchant_remarkstring必须商家留言
├─ express_contentstring必须物流内容
├─ is_deletenumber必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ expressRelationobject []必须详情关联物流信息

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须商城ID
├─ mch_idnumber必须商户ID
├─ order_idnumber必须订单ID
├─ order_detail_idnumber必须订单详情ID
├─ order_detail_express_idnumber必须关联物流详情ID
├─ is_deletenumber必须
├─ orderDetailobject必须
├─ idnumber非必须商品详情ID
├─ order_idnumber非必须关联订单ID
├─ goods_idnumber非必须商品ID
├─ numnumber非必须商品数量
├─ unit_pricestring非必须商品单价
├─ total_original_pricestring非必须商品原总价(优惠前)
├─ total_pricestring非必须商品总价(优惠后)
├─ member_discount_pricestring非必须会员优惠金额(正数表示优惠,负数表示加价)
├─ goods_infoobject非必须商品信息josn格式
├─ namestring非必须商品名称
├─ attr_listobject []非必须已选规格信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ pic_urlstring非必须商品缩略图
├─ numnumber非必须商品数量
├─ total_original_pricestring非必须商品总价(优惠前)
├─ member_discount_pricestring非必须会员折扣金额
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_refundnumber非必须商品是否退款
├─ refund_statusnumber非必须售后状态 0--未售后 1--售后中 2--售后结束
├─ back_pricestring非必须售后状态 0--未售后 1--售后中 2--售后结束
├─ signstring非必须订单详情标识,用于区分插件
├─ goods_nostring非必须商品货号
├─ detailExpressRelationobject []非必须

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须商城ID
├─ mch_idnumber必须商户ID
├─ order_idnumber必须订单ID
├─ order_detail_idnumber必须订单详情ID
├─ order_detail_express_idnumber必须关联物流详情ID
├─ is_deletenumber必须
├─ vipCardDiscountstring []非必须

item 类型: string

├─ 非必须
├─ status_textstring非必须订单状态(中文)
├─ pay_type_textstring非必须
├─ goods_numnumber非必须商品数量
├─ member_deduction_price_countstring非必须会员抵扣价格
├─ citynull非必须城市
├─ plugin_datastring []非必须插件相关数据

item 类型: string

├─ 非必须
├─ is_offlinestring非必须兼容旧版本 该字段与send_type相同
├─ is_show_send_typeinteger非必须是否显示配送方式

枚举: 0,1

枚举备注: 0--不显示 1--显示

├─ type_dataobject非必须
├─ ecardobject []必须电子卡密信息

item 类型: object

├─ keystring必须卡密字段
├─ valuestring必须卡密数据
├─ goods_typestring非必须商品类型

枚举: goods,ecard

枚举备注: goods--实体商品 ecard--电子卡密

├─ is_can_apply_salesinteger非必须是否显示售后按钮 0--否 1--是
├─ is_show_expressinteger非必须是否展示运费 0--否 1--是

裂变红包

分享赠送

基本信息

Path: /plugin/fxhb/api/index/share-send

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 7 活动id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ card_listobject []非必须赠送的卡券

item 类型: object

├─ mall_idnumber必须商城id
├─ user_idnumber必须用户id
├─ card_idnumber必须卡券id
├─ namestring必须卡券名称
├─ pic_urlstring必须卡券封面
├─ contentstring必须卡券内容
├─ created_atstring必须
├─ is_usenumber必须是否使用 0未使用 1已使用
├─ clerk_idnumber必须核销
├─ store_idnumber必须门店
├─ clerked_atstring必须
├─ order_idnumber必须
├─ order_detail_idnumber必须
├─ datastring必须
├─ start_timestring必须
├─ end_timestring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ idnumber必须
├─ user_coupon_listobject []非必须赠送优惠券

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ namestring必须
├─ typenumber必须
├─ discountstring必须
├─ discount_limitstring必须
├─ pic_urlnumber必须
├─ descstring必须
├─ min_pricestring必须
├─ sub_pricestring必须
├─ total_countnumber必须
├─ sortnumber必须
├─ expire_typenumber必须
├─ expire_daynumber必须
├─ begin_timestring必须
├─ end_timestring必须
├─ appoint_typenumber必须
├─ rulestring必须
├─ is_membernumber必须
├─ is_deletenumber必须
├─ deleted_atstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ contentstring必须
├─ send_balancestring非必须赠送余额
├─ send_integral_numstring非必须赠送积分

后台新增/编辑活动

基本信息

Path: /plugin/fxhb/mall/activity/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
form text 是 {"cat_id_list":[],"goods_id_list":[],"status":"0","type":"1","number":4,"effective_time":30,"open_effective_time":24,"coupon_type":"3","sponsor_num":-1,"help_num":-1,"sponsor_count":-1,"sponsor_count_type":"0","share_title":"11111","pic_url":"http://localhost/foal_store/web/uploads/mall1/20191123/2f02c09396fbf2ae7f454658f32a78db.jpg","start_end_time":["2019-12-04","2019-12-06"],"name":"哈哈","remark":"fd","count_price":"111","least_price":"11","share_pic_url":"http://localhost/foal_store/web/uploads/mall1/20191123/2f02c09396fbf2ae7f454658f32a78db.jpg",

"send_type":1,
"send_num":100,
"coupons":[{"id":"1","coupon_id":"5","send_num":"2","is_delete":"0","name":"测试优惠券"}],"cards":[{"id":"1","card_id":"1","send_num":"3","is_delete":"0","name":"aaa"}]
,"id":7} | 赠送优惠券: "coupons":[{"id":"1","coupon_id":"5","send_num":"2","is_delete":"0","name":"测试优惠券"}]

赠送卡券:"cards":[{"id":"1","card_id":"1","send_num":"3","is_delete":"0","name":"aaa"}]

"send_type":0不赠送 1赠送余额 2赠送积分
"send_num":赠送数量 |

返回数据

名称类型是否必须默认值备注其他信息

拆红包

基本信息

Path: /fxhb/api/index/join

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
user_activity_id text 否 分享用户的活动id

返回数据

名称类型是否必须默认值备注其他信息

拆红包结果

基本信息

Path: /fxhb/api/index/join-result

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
queueId 是
token 是

返回数据

名称类型是否必须默认值备注其他信息

拆红包详情

基本信息

Path: /fxhb/api/index/detail

Method: GET

接口描述:

拆红包详情

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
user_activity_id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ nicknamestring非必须参与用户昵称
├─ avatarstring非必须参与用户头像
├─ get_pricenumber非必须参与用户瓜分金额
├─ maxnumber非必须是否是最大值
├─ statusnumber非必须拆红包状态0--进行中 1--成功 2--失败
├─ is_joinnumber非必须当前用户是否参与拆红包0--否 1--是
├─ min_pricestring非必须红包使用最小值
├─ user_pricestring非必须当前用户红包金额
├─ reset_timeinteger非必须剩余时间(秒)
├─ is_my_hongbaointeger非必须是否是本人发起的
├─ coupon_total_moneynumber非必须红包总额
├─ user_numnumber非必须剩余人数

活动配置

基本信息

Path: /fxhb/api/index/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ configobject非必须当前拆红包活动配置
├─ idnumber非必须活动id
├─ numbernumber非必须拆包人数
├─ count_pricestring非必须红包总金额
├─ share_titlestring非必须分享标题
├─ share_pic_urlstring非必须分享图片
├─ pic_urlstring非必须活动图片
├─ remarkstring非必须活动规则
├─ user_activity_idstring非必须用户参与的拆红包活动ID 若没有则为null

订单后台

售后列表

基本信息

Path: /order/refund

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 0 -1全部 0未处理 1 已处理 2代发货 3待收货
user_id 是
date_start 是
date_end 是
keyword 是
keyword_1 是 1 订单号搜索 2 昵称搜索 3名称搜索4订单id搜索5 6收件人号码搜索

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须售后订单列表(详情见售后表)

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ order_idstring必须
├─ order_detail_idstring必须
├─ order_nostring必须
├─ typestring必须
├─ refund_pricestring必须
├─ remarkstring必须
├─ pic_liststring必须
├─ statusstring必须
├─ status_timestring必须
├─ merchant_remarkstring必须
├─ is_sendstring必须
├─ send_timestring必须
├─ expressstring必须
├─ express_nostring必须
├─ address_idstring必须
├─ is_confirmstring必须
├─ confirm_timestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ namestring必须收件人
├─ mobilestring必须电话号码
├─ addressstring必须地址
├─ pay_typestring必须支付方式
├─ detailobject必须订单详情
├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infostring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ sortstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_levelstring非必须
├─ confine_countstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ is_negotiablestring非必须
├─ freight_idstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ addressobject []非必须后台收货地址

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ mch_idnumber必须
├─ namestring必须
├─ addressstring必须
├─ mobilestring必须
├─ remarkstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ exportListstring []非必须

item 类型: string

├─ 非必须

售后处理

基本信息

Path: /order/refund-handle

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_refund_id text 是
type text 是 1退货 2 换货
is_agree text 是 1同意 0拒绝
refund text 是 1退货 2退货退款
refund_price text 是 退货价格 为空表示原支付价
address_id text 是 地址ID
merchant_remark text 是 商家同意

返回数据

名称类型是否必须默认值备注其他信息

订单列表

基本信息

Path: /order/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 否 -1全部 0未付款 1待发货 2待收货 3已完成 4待处理/待退款 5已取消 7 回收站
store_id 否 门店id
date_start 是 开始时间 y-m-sH:i:s
date_end 是
clerk_id 是 核销员id
user_id 是 用户id
is_offline 是 是否到店自提:0.否
keyword 是
keyword_1 是 1 订单号搜索 2 昵称搜索 3名称搜索4订单id搜索5 商品搜索6收件人号码搜索

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ mch_idstring必须
├─ order_nostring必须
├─ total_pricestring必须
├─ total_pay_pricestring必须
├─ express_pricestring必须
├─ total_goods_pricestring必须
├─ total_goods_original_pricestring必须
├─ member_discount_pricestring必须
├─ use_user_coupon_idstring必须
├─ coupon_discount_pricestring必须
├─ use_integral_numstring必须
├─ integral_deduction_pricestring必须
├─ namestring必须
├─ mobilestring必须
├─ addressstring必须
├─ remarkstring必须
├─ order_formobject,null必须
├─ wordsstring必须
├─ seller_remarkstring必须
├─ is_paystring必须
├─ pay_typestring必须
├─ pay_timestring必须
├─ is_sendstring必须
├─ send_timestring必须
├─ expressstring必须
├─ express_nostring必须
├─ is_salestring必须
├─ is_confirmstring必须
├─ confirm_timestring必须
├─ cancel_statusstring必须
├─ cancel_timestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_recyclestring必须
├─ is_offlinestring必须
├─ offline_qrcodestring必须
├─ clerk_idstring必须
├─ store_idstring必须
├─ tokenstring必须
├─ nicknamestring必须用户昵称
├─ detailobject []必须订单详情信息(备注见order_detail)

item 类型: object

├─ idstring必须
├─ order_idstring必须
├─ goods_idstring必须
├─ numstring必须
├─ unit_pricestring必须
├─ total_original_pricestring必须
├─ total_pricestring必须
├─ member_discount_pricestring必须
├─ goods_infostring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ goodsobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ sortstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_levelstring非必须
├─ confine_countstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ is_negotiablestring非必须
├─ freight_idstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ refundnull必须商品售后情况
├─ attr_listobject []必须商品规格

item 类型: object

├─ attr_group_namestring必须规格组
├─ attr_group_idnumber,string必须
├─ attr_idnumber,string必须
├─ attr_namestring必须规格名
├─ clerkobject必须核销人信息
├─ field_2string必须
├─ storeobject必须门店信息
├─ exportListstring []非必须导出信息(未处理)

item 类型: string

├─ 非必须

订单详情后台

基本信息

Path: /order/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
order_id 是 订单ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ orderobject非必须详见order表
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ mch_idstring非必须
├─ order_nostring非必须
├─ total_pricestring非必须
├─ total_pay_pricestring非必须
├─ express_pricestring非必须
├─ total_goods_pricestring非必须
├─ total_goods_original_pricestring非必须
├─ member_discount_pricestring非必须
├─ use_user_coupon_idstring非必须
├─ coupon_discount_pricestring非必须
├─ use_integral_numstring非必须
├─ integral_deduction_pricestring非必须
├─ namestring非必须收件人
├─ mobilestring非必须手机号码
├─ addressstring非必须地址
├─ remarkstring非必须
├─ wordsstring非必须商家留言
├─ seller_remarkstring非必须商家订单备注
├─ is_paystring非必须是否支付:0.未支付|1.已支付
├─ pay_typestring非必须
├─ pay_timestring非必须支付时间
├─ is_sendstring非必须
├─ send_timestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ is_salestring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ cancel_statusstring非必须
├─ cancel_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ is_recyclestring非必须
├─ is_offlinestring非必须
├─ offline_qrcodestring非必须
├─ clerk_idstring非必须
├─ store_idstring非必须
├─ tokenstring非必须
├─ userobject非必须用户信息
├─ idstring非必须
├─ mall_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ detailobject []非必须

item 类型: object

├─ idstring非必须
├─ order_idstring非必须
├─ goods_idstring非必须
├─ numstring非必须
├─ unit_pricestring非必须
├─ total_original_pricestring非必须
├─ total_pricestring非必须
├─ member_discount_pricestring非必须
├─ goods_infostring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ goodsobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ namestring非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusstring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须
├─ pic_urlobject []非必须商品轮播图

item 类型: object

├─ idstring必须
├─ pic_urlstring必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesstring非必须
├─ sortstring非必须
├─ is_quick_shopstring非必须
├─ is_sell_wellstring非必须
├─ is_levelstring非必须
├─ confine_countstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ is_negotiablestring非必须
├─ freight_idstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ refundobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ order_detail_idstring非必须
├─ order_nostring非必须
├─ typestring非必须
├─ refund_pricestring非必须
├─ remarkstring非必须
├─ pic_liststring非必须
├─ statusstring非必须
├─ status_timestring非必须
├─ refuse_remarkstring非必须
├─ is_sendstring非必须
├─ send_timestring非必须
├─ expressstring非必须
├─ express_nostring非必须
├─ address_idstring非必须
├─ is_confirmstring非必须
├─ confirm_timestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attr_listobject []非必须规格信息

item 类型: object

├─ attr_group_namestring必须规格组
├─ attr_group_idstring,number必须
├─ attr_idstring,number必须
├─ attr_namestring必须规格名
├─ refundstring非必须0未售后,1.待商家处理 2.同意 3.拒绝
├─ order_formstring []非必须订单form(未处理)

item 类型: string

├─ 非必须
├─ mchstring []非必须多商户(未处理)

item 类型: string

├─ 非必须

步数宝后台

活动解散

基本信息

Path: /step/mall/activity/disband

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称类型是否必须默认值备注其他信息

商品列表

基本信息

Path: /step/mall/goods/search

Method: GET

接口描述:
undefined

请求参数

商品编辑预览

基本信息

Path: /step/mall/goods/edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ currencystring非必须活力币数量
├─ goods_idnumber非必须商品id
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须

基本设置列表

基本信息

Path: /plugin/step/mall/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须详见step_setting表
├─ idnumber非必须
├─ mall_idnumber非必须
├─ convert_maxnumber非必须
├─ convert_rationumber非必须
├─ currency_namestring非必须
├─ activity_picstring非必须
├─ ranking_picstring非必须
├─ qrcode_picobject []非必须

item 类型: object

├─ pic_urlstring必须
├─ link_urlstring必须
├─ invite_rationumber非必须
├─ remind_atstring非必须
├─ rulestring非必须
├─ activity_rulestring非必须
├─ ranking_numnumber非必须
├─ titlestring非必须
├─ share_titlestring非必须
├─ qrcode_titlestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须

基本设置提交

基本信息

Path: /step/mall/setting

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
convert_max text 是 1 每日最高兑换数
convert_ratio text 是 1 兑换比率
currency_name text 是 1 活力币别名
activity_pic text 是 1 活动背景
ranking_pic text 是 1 排行榜背景
qrcode_pic text 是 1 海报缩略图(暂定为json数组)
invite_ratio text 是 22 邀请比率
remind_at text 是 12 提醒时间
rule text 是 1 规则
activity_rule text 是 1 活动规则
ranking_num text 是 1 全国排行限制
title text 是 1 小程序标题
share_title text 是 1 转发标题
qrcode_title text 是 1 海报文字

返回数据

名称类型是否必须默认值备注其他信息

步数币修改

基本信息

Path: /step/mall/user/edit-currency

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
type text 是 1 1加 2减
step_id text 是 1 步数宝用户id
currency text 是 1 金额

返回数据

名称类型是否必须默认值备注其他信息

活动保存

基本信息

Path: /step/mall/step/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
title text 是 1 活动标题
status text 是 0 0关闭 1开启
begin_at text 是 2018/20/10 1:1:1 开始时间
end_at text 是 2018/20/10 1:1:1 结束时间
currency text 否 1 奖金池
step_num text 是 0 挑战步数
bail_currency text 否 1 保证金

返回数据

名称类型是否必须默认值备注其他信息

活动列表

基本信息

Path: /step/mall/activity

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须详见step-activity

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ titlestring必须
├─ currencystring必须
├─ step_numstring必须
├─ bail_currencystring必须
├─ statusstring必须
├─ typestring必须
├─ begin_atstring必须
├─ end_atstring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ deleted_atstring必须
├─ activity_typestring必须1完成2解散4关闭5未开始6进行中

活动删除

基本信息

Path: /step/mall/activity/destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1

活动参与名单

基本信息

Path: /step/mall/activity/partake-list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ step_idstring非必须
├─ activity_idstring非必须
├─ step_currencystring非必须报名费
├─ statusstring非必须0报名 1成功 2失败
├─ created_atstring非必须
├─ raffled_atstring非必须
├─ total_numstring非必须总步数
├─ stepobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ ratiostring非必须
├─ step_currencystring非必须
├─ parent_idstring非必须
├─ invite_ratiostring非必须
├─ is_remindstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ userobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

活动编辑

基本信息

Path: /step/mall/activity/edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须详见step-activity
├─ listobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ titlestring非必须
├─ currencystring非必须
├─ step_numnumber非必须
├─ bail_currencystring非必须
├─ statusnumber非必须
├─ typenumber非必须
├─ begin_atstring非必须
├─ end_atstring非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ deleted_atstring非必须

商品编辑提交

基本信息

Path: /step/mall/goods/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
currency text 是 1 活力币金额位置待确认 (其他参数详见bargain-goods-edit)

返回数据

名称类型是否必须默认值备注其他信息

活动首页状态

基本信息

Path: /step/mall/activity/edit-status

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1
status text 是 1 0关闭

流量主列表

基本信息

Path: /step/mall/ad

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ unit_idstring非必须模板号
├─ sitestring非必须select 位置关联
├─ statusstring非必须0关闭 1开启
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ selectobject []非必须select(可更换名称)

item 类型: object

├─ valuenumber必须
├─ namestring必须

流量主删除

基本信息

Path: /step/mall/ad/destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是

流量主编辑详情

基本信息

Path: /step/mall/ad/edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ unit_idstring非必须
├─ sitenumber非必须
├─ statusnumber非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ selectobject []非必须select(看更换名称)

item 类型: object

├─ valuenumber必须
├─ namestring必须

流量主编辑详情提交

基本信息

Path: /step/mall/ad/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 id 1
status text 是 0 状态 0关
site text 是 1 select 位置
unit_id text 是 3213123 模板id

返回数据

名称类型是否必须默认值备注其他信息

流量主首页切换

基本信息

Path: /step/mall/ad/edit-status

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1
status text 是 1 0关闭 1开启

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

用户中心

基本信息

Path: /step/mall/user

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ ratiostring非必须
├─ step_currencystring非必须
├─ parent_idstring非必须
├─ invite_ratiostring非必须
├─ is_remindstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ child_numstring非必须邀请人数
├─ userobject非必须用户信息
├─ idstring非必须
├─ mall_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

用户兑换记录

基本信息

Path: /step/mall/user/log

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 step_user_id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ step_idstring非必须
├─ typestring非必须1收入 2 支出
├─ currencystring非必须货币
├─ remarkstring非必须详情
├─ datastring非必须
├─ created_atstring非必须

用户邀请记录

基本信息

Path: /step/mall/user/invite

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须
├─ invite_listobject []非必须邀请列表

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ ratiostring非必须
├─ step_currencystring非必须
├─ parent_idstring非必须
├─ invite_ratiostring非必须
├─ is_remindstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ userobject非必须个人信息
├─ idstring非必须
├─ mall_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须

轮播图列表

基本信息

Path: /step/mall/banner

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须同之前
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

轮播图编辑

基本信息

Path: /step/mall/banner/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
ids text 是 [{}] 同之前

返回数据

名称类型是否必须默认值备注其他信息

步数宝前端

活动提交

基本信息

Path: /step/api/step/activity-submit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
activity_id text 是 活动id
num text 是 真实步数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
datanumber非必须提交步数

参加活动

基本信息

Path: /step/api/step/activity-join

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
activity_id 是 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

商品详情

基本信息

Path: /step/api/step/goods-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ attr_groupobject []非必须规格组

item 类型: object

├─ attr_group_idnumber非必须
├─ attr_group_namestring非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ attrobject []非必须规格信息

item 类型: object

├─ idnumber非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stocknumber非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ is_deletenumber非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ member_price_2number非必须
├─ price_membernumber非必须
├─ member_price_3number非必须
├─ member_price_4number非必须
├─ member_price_5number非必须
├─ member_price_6number非必须
├─ member_price_7number非必须
├─ member_price_8number非必须
├─ member_price_9number非必须
├─ member_price_10number非必须
├─ member_price_11number非必须
├─ member_price_12number非必须
├─ member_price_13number非必须
├─ member_price_14number非必须
├─ namestring非必须
├─ pic_urlobject []非必须

item 类型: object

├─ idstring必须
├─ pic_urlstring必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ pricestring非必须价格
├─ detailstring非必须详情
├─ goods_idnumber非必须
├─ currencystring非必须活力币金额
├─ idnumber非必须步数宝商品id

基本配置

基本信息

Path: /step/api/step/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ convert_maxstring非必须
├─ convert_ratiostring非必须
├─ currency_namestring非必须
├─ activity_picstring非必须
├─ ranking_picstring非必须
├─ qrcode_picobject []非必须海报图

item 类型: object

├─ pic_urlstring必须
├─ link_urlstring必须
├─ invite_ratiostring非必须
├─ remind_atstring非必须
├─ rulestring非必须
├─ activity_rulestring非必须
├─ ranking_numstring非必须
├─ titlestring非必须
├─ share_titlestring非必须分享转发文字
├─ qrcode_titlestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须

排行

基本信息

Path: /step/api/step/ranking

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 1好友 2全国

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须列表

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ ratiostring必须
├─ step_currencystring必须
├─ parent_idstring必须
├─ invite_ratiostring必须
├─ is_remindstring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ deleted_atstring必须
├─ nicknamestring必须
├─ avatarstring必须
├─ userobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ ratiostring非必须
├─ step_currencystring非必须
├─ parent_idstring非必须
├─ invite_ratiostring非必须
├─ is_remindstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ userobject非必须个人信息
├─ idstring非必须
├─ mall_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ store_idstring非必须
├─ platformstring非必须
├─ rakingstring非必须排行
├─ nicknamestring非必须
├─ avatarstring非必须
├─ ad_datanull非必须

步数排行

基本信息

Path: /step/api/step/step-convert

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
status 是 1每日 2周

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ step_idstring必须
├─ ratiostring必须
├─ real_numstring必须
├─ numstring必须
├─ created_atstring必须
├─ total_numstring必须总步数
├─ stepobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ ratiostring非必须
├─ step_currencystring非必须
├─ parent_idstring非必须
├─ invite_ratiostring非必须
├─ is_remindstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ userobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ usernamestring非必须
├─ passwordstring非必须
├─ nicknamestring非必须
├─ auth_keystring非必须
├─ access_tokenstring非必须
├─ mobilestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ userInfoobject非必须
├─ idstring非必须
├─ user_idstring非必须
├─ avatarstring非必须
├─ platform_user_idstring非必须
├─ integralstring非必须
├─ total_integralstring非必须
├─ balancestring非必须
├─ parent_idstring非必须
├─ is_blackliststring非必须
├─ contact_waystring非必须
├─ remarkstring非必须
├─ is_deletestring非必须
├─ junior_atstring非必须
├─ store_idstring非必须
├─ platformstring非必须
├─ nicknamenull必须名称
├─ avatarnull必须头像

每日兑换

基本信息

Path: /step/api/step/convert

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
num text 是
code text 是
encrypted_data text 是
iv text 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
listobject非必须
├─ numnumber非必须
├─ convertnumber非必须兑换额

活动列表

基本信息

Path: /step/api/step/activity

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
iv text 是
encrypted_data text 是
code text 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
listobject非必须
├─ activity_dataobject []非必须详见step-activity

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ titlestring非必须
├─ currencystring非必须
├─ step_numstring非必须
├─ bail_currencystring非必须
├─ statusstring非必须
├─ typestring非必须
├─ begin_atstring非必须
├─ end_atstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ award_numnumber非必须达标人数
├─ currency_numnumber非必须奖金数
├─ people_numnumber非必须参与人数
├─ lognull非必须
├─ log_statusnull非必须null未参与 0参与1达标2成功3失败
├─ daily_real_numnumber非必须当前步数
├─ ad_datanull非必须流量主

商品列表

基本信息

Path: /step/api/step/goods

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ namestring必须
├─ cover_picstring必须
├─ idnumber必须
├─ goods_idnumber必须

活动记录

基本信息

Path: /step/api/step/activity-log

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ step_idstring非必须
├─ activity_idstring非必须
├─ step_currencystring非必须
├─ reward_currencystring非必须
├─ statusstring非必须
├─ created_atstring非必须
├─ raffled_atstring非必须
├─ user_numnull非必须提交步数
├─ activityobject非必须活动信息
├─ idstring非必须
├─ mall_idstring非必须
├─ titlestring非必须
├─ currencystring非必须
├─ step_numstring非必须
├─ bail_currencystring非必须
├─ statusstring非必须
├─ typestring非必须
├─ begin_atstring非必须
├─ end_atstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ infoobject非必须
├─ total_boutnumber非必须总局数
├─ total_currencynumber非必须总奖励
├─ boutnumber非必须赢局数
├─ bout_rationumber非必须比率

活动详情

基本信息

Path: /step/api/step/activity-detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
activity_id 是 1 活动id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须详见step-activity

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ titlestring非必须
├─ currencystring非必须
├─ step_numstring非必须
├─ bail_currencystring非必须
├─ statusstring非必须
├─ typestring非必须
├─ begin_atstring非必须
├─ end_atstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须

用户提醒

基本信息

Path: /step/api/step/remind

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
is_remind text 是 1 是否提醒

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

用户记录

基本信息

Path: /step/api/step/log

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ stepUserobject非必须用户相关信息
├─ idnumber非必须
├─ mall_idnumber非必须
├─ user_idnumber非必须
├─ rationumber非必须
├─ step_currencystring非必须
├─ parent_idnumber非必须
├─ invite_rationumber非必须
├─ is_remindnumber非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ listobject []非必须列表

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ step_idstring非必须
├─ typestring非必须1收入 2 支出
├─ currencystring非必须
├─ remarkstring非必须详情
├─ datastring非必须
├─ created_atstring非必须

订单提交

基本信息

Path: /step/api/step/order-submit

Method: GET

接口描述:
undefined

请求参数

订单预览

基本信息

Path: /step/api/step/order-preview

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息

邀请列表

基本信息

Path: /step/api/step/invite-list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ ratiostring必须
├─ step_currencystring必须
├─ parent_idstring必须
├─ invite_ratiostring必须
├─ is_remindstring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ deleted_atstring必须
├─ nicknamestring,null必须
├─ avatarstring,null必须
├─ countnumber非必须
├─ now_countstring非必须今天邀请数

首页接口

基本信息

Path: /step/api/step/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token 0DBfMLNTV2H_EqWr1fn7zowiROUfwind 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ user_dataobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ ratiostring非必须
├─ step_currencystring非必须
├─ parent_idstring非必须
├─ invite_ratiostring非必须
├─ is_remindstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ convert_numstring非必须
├─ old_ratiostring非必须
├─ daily_invite_numstring非必须今天邀请数
├─ invite_liststring []非必须邀请列表

item 类型: string

├─ 非必须
├─ all_invitenumber非必须总邀请数
├─ daily_rationumber非必须今天加成数
├─ daily_real_numnumber非必须今日真实步数 兑换传此参数
├─ daily_numnumber非必须今日可兑换
├─ activity_dataobject非必须活动数据详见step-activity
├─ idstring非必须
├─ mall_idstring非必须
├─ titlestring非必须
├─ currencystring非必须
├─ step_numstring非必须
├─ bail_currencystring非必须
├─ statusstring非必须
├─ typestring非必须
├─ begin_atstring非必须
├─ end_atstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ lognull非必须
├─ log_statusnull非必须null 未报名 0报名1达标2成功3失败
├─ people_numstring非必须参与人数
├─ total_currencynumber非必须奖金池
├─ people_reach_numstring非必须达标数
├─ ad_dataobject非必须流量主数据
├─ idnumber非必须
├─ mall_idnumber非必须
├─ unit_idstring非必须
├─ sitenumber非必须
├─ statusnumber非必须
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ banner_liststring []非必须

item 类型: string

├─ 非必须

卡券

二维码接口

基本信息

Path: /api/card/card-qrcode

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是
X-App-Platform wx 是

Query

参数名称 是否必须 示例 备注
cardId 是

返回数据

名称类型是否必须默认值备注其他信息

卡券核销

基本信息

Path: /card/card-clerk

Method: GET

接口描述:

卡券核销

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
cardId 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

卡券详情

基本信息

Path: /card/user-card-detail

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
cardId 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ cardobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ user_idstring非必须
├─ card_idstring非必须
├─ namestring非必须卡券名称
├─ pic_urlstring非必须卡券图片
├─ contentstring非必须卡券内容
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ is_usestring非必须是否使用 0--未使用|1--已使用
├─ clerk_idstring非必须核销员ID
├─ store_idstring非必须核销门店ID
├─ clerked_atstring非必须核销时间
├─ order_idstring非必须
├─ goods_idstring非必须
├─ datastring非必须
├─ clerknull非必须核销员信息
├─ storenull非必须核销门店信息

我的卡券列表

基本信息

Path: /card/user-card

Method: GET

接口描述:

我的卡券列表

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
page 是
status 是 状态1--未使用 2--已使用 3--已过期

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ user_idnumber必须
├─ mall_idnumber必须
├─ namestring必须卡券名称
├─ pic_urlstring必须卡券图片
├─ contentstring必须卡券说明
├─ is_usenumber必须是否使用 0--未使用|1--已使用

海报

基本信息

Path: /card/give-poster

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cardId 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ avatarstring非必须头像
├─ nicknamestring非必须昵称
├─ namestring非必须卡券名称
├─ pic_urlstring非必须卡券图片
├─ reset_numbernumber非必须剩余核销次数
├─ start_timestring非必须有效期开始时间
├─ end_timestring非必须有效期结束时间
├─ qrcodestring非必须二维码图片路径

赠送页面

基本信息

Path: /card/give

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cardId 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ avatarstring非必须头像
├─ nicknamestring非必须昵称
├─ namestring非必须卡券名称
├─ pic_urlstring非必须卡券图片
├─ reset_numbernumber非必须剩余核销次数
├─ is_usenumber非必须是否可用
├─ start_timestring非必须有效期开始时间
├─ end_timestring非必须有效期结束时间
├─ statusnumber非必须卡券状态

枚举: 0,1,2,3

枚举备注: 0--卡券失效 1--卡券可领取 2--卡券已领取 3--卡券已被他人领取

领取赠送的卡券

基本信息

Path: /card/receive

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cardId 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

商品

商品推荐列表

基本信息

Path: /api/goods/new-recommend

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
goods_id 否 1 商品详情页的推荐列表需再传
type 是 goods 可选 goods

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须商品ID
├─ goods_warehouse_idnumber必须商品库ID
├─ mch_idnumber必须商户ID
├─ signstring必须插件标识
├─ namestring必须商品名称
├─ cover_picstring必须商品缩略图
├─ original_pricestring必须商品原价
├─ unitstring必须商品单位
├─ page_urlstring必须页面跳转url
├─ is_negotiablenumber必须是否面议0.否|1.是
├─ is_levelnumber必须是否显示会员价0.否|1.是
├─ level_pricenumber必须会员价
├─ pricestring必须商品售价
├─ price_contentstring必须前端显示的售价
├─ is_salesstring必须是否显示销量0.否|1.是
├─ salesstring必须销量(包含虚拟销量)
├─ vip_card_appointobject必须
├─ discountnull,string非必须折扣
├─ is_my_vip_card_goodsnumber非必须登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_usernumber非必须登录用户是不是会员 1是 0否

商品视频列表

基本信息

Path: /api/goods/goods-list

Method: GET

接口描述:

参数同商品列表

请求参数

Query

参数名称 是否必须 示例 备注
goodsId 是 1 商品id
page 是 1 分页页数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须商品列表

item 类型: object

├─ idnumber必须商品id
├─ goods_warehouse_idnumber必须商品库id
├─ mch_idnumber必须多商户id
├─ signstring必须商品插件标示
├─ namestring必须商品名称
├─ cover_picstring必须商品封面图
├─ original_pricestring必须商品原价
├─ unitstring必须商品单位
├─ page_urlstring必须商品跳转路径
├─ is_negotiablenumber必须是否价格面议
├─ is_levelnumber必须是否享受会员价
├─ level_pricenumber必须会员价
├─ pricestring必须售价
├─ price_contentstring必须价格文本
├─ is_salesstring必须是否显示销量
├─ salesstring必须销量文本
├─ attr_groupsobject []必须规格组

item 类型: object

├─ attr_group_idnumber必须
├─ attr_group_namestring必须
├─ attr_listobject []必须

item 类型: object

├─ attr_idnumber必须
├─ attr_namestring必须
├─ pic_urlstring必须
├─ attrobject []必须多规格信息

item 类型: object

├─ idstring必须
├─ goods_idnumber必须
├─ sign_idstring必须
├─ stockstring必须
├─ pricestring必须
├─ nostring必须
├─ weightnumber必须
├─ pic_urlstring必须
├─ is_deletenumber必须
├─ attr_listobject []必须

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ goods_stocknumber必须商品库存
├─ vip_card_appointobject必须超级会员卡信息
├─ discountnull,string非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ video_urlstring必须视频路径
├─ app_share_titlestring必须自定义分享标题
├─ app_share_picstring必须自定义分享图片

评价列表

基本信息

Path: /api/goods/comments-list

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
goods_id 是
page 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ commentsobject []非必须评论列表

item 类型: object

├─ contentstring非必须评论内容
├─ pic_urlstring非必须评论图片
├─ reply_contentstring非必须商家回复
├─ avatarstring非必须用户头像
├─ timestring非必须评论时间
├─ nicknamestring非必须用户昵称
├─ comment_countobject []非必须评论类型

item 类型: object

├─ namestring必须类型名称

枚举: 全部,好评,中评,差评

├─ countstring,number必须数量
├─ indexnumber必须

后台-商城管理

创建商城

基本信息

Path: /admin/mall/create

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 微商城 商城名称

商城列表

基本信息

Path: /admin/mall/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
keyword 否 商城 商城名称

返回数据

名称类型是否必须默认值备注其他信息

商城加入回收站|恢复

基本信息

Path: /admin/mall/update

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 商城ID
is_recycle text 是 1 是否加入回收站0.移出回收站

商城禁用|解禁

基本信息

Path: /admin/mall/disable

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 商城ID
status 是 1 0.禁用

返回数据

名称类型是否必须默认值备注其他信息

商城迁移

基本信息

Path: /admin/mall/removal

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
user_id 是 1 迁移至账号的用户ID
mall_id 是 1 被迁移商城ID

回收站删除商城

基本信息

Path: /admin/mall/delete

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 商城ID

版权设置

基本信息

Path: /mall/copyright/setting

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
form[pic_url] text 是 https://ww3.sinaimg.cn/bmiddle/b5e8f4a9gy1fut2jh80n1j21221von9t.jpg 版权图标
form[description] text 是 111 版权描述
form[type] text 是 1 类型1.链接跳转
form[link_url] text 是 /pages/order/order?status=-1 跳转链接
form[mobile] text 是 15788888888 电话

砍价

轮播图

基本信息

Path: /bargain/api/index/banner

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是 FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW

返回数据

名称类型是否必须默认值备注其他信息

商品列表

基本信息

Path: /bargain/api/goods/list

Method: GET

接口描述:

砍价商品列表

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
page 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ namestring非必须商品名称
├─ cover_picstring非必须商品图片
├─ pricestring非必须售价
├─ min_pricestring非必须最低价
├─ salesnumber非必须参与人数
├─ goods_idstring非必须商品id
├─ statusnumber非必须砍价活动开始或关闭
├─ user_listobject []非必须

item 类型: object

├─ avatarstring必须砍价用户头像
├─ stockstring非必须商品库存

商品详情

基本信息

Path: /bargain/api/goods/detail

Method: GET

接口描述:

商品详情

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
goods_id 是 砍价id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ bargainobject非必须
├─ namestring非必须商品名称
├─ pic_urlobject []非必须商品轮播图

item 类型: object

├─ idstring必须
├─ pic_urlstring必须
├─ video_urlstring非必须商品视频
├─ unitstring非必须商品单位
├─ pricestring非必须商品价格
├─ detailstring非必须商品详情
├─ goods_idnumber非必须商品ID
├─ min_pricestring非必须商品最低价
├─ stocknumber非必须商品库存
├─ begin_timestring非必须砍价开始时间
├─ end_timestring非必须砍价结束时间
├─ typenumber非必须是否允许中途下单 1--允许 2--不允许
├─ timenumber非必须砍价时间
├─ join_numnumber非必须参与人数
├─ bargain_infoobject非必须
├─ reset_timenumber非必须剩余砍价时间
├─ pricenumber非必须商品价格
├─ min_pricenumber非必须商品最低价
├─ now_pricenumber非必须当前价
├─ listobject非必须
├─ nicknamestring非必须砍价用户昵称
├─ avatarstring非必须砍价用户头像
├─ pricenumber非必须砍价金额
├─ bargain_pricenumber非必须已砍金额
├─ finish_atstring非必须砍价结束时间
├─ sharenumber非必须合伙人金额

用户发起砍价订单

基本信息

Path: /bargain/api/order/bargain-submit

Method: GET

接口描述:

用户发起砍价

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
goods_id 是 砍价活动id

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject必须
├─ queueIdstring非必须
├─ tokenstring必须

用户发起砍价结果

基本信息

Path: /bargain/api/order/bargain-result

Method: GET

接口描述:

用户发起砍价结果

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Tokem FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
queueId 是
token 是

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
dataobject必须
├─ retrystring必须重新请求接口
├─ bargain_order_idstring必须用户发起砍价的订单ID

用户参与砍价

基本信息

Path: /bargain/api/order/user-join-bargain

Method: GET

接口描述:

用户参与砍价

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
bargain_order_id 是 用户发起砍价结果 接口返回值

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
dataobject必须
├─ queueIdstring必须
├─ tokenstring必须

用户参与砍价结果

基本信息

Path: /bargain/api/order/user-join-bargain-result

Method: GET

接口描述:

用户参与砍价的砍价信息

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
queueId 是 用户参与砍价 接口返回值
token 是 用户参与砍价 接口返回值

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
dataobject必须
├─ user_idstring必须帮砍用户ID
├─ nicknamestring必须帮砍用户昵称
├─ pricestring必须帮砍用户砍价金额

活动页面

基本信息

Path: /bargain/api/order/activity

Method: GET

接口描述:

砍价活动页面

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
bargain_order_id 是
page 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ reset_timenumber非必须剩余时间
├─ pricenumber非必须商品价格
├─ min_pricenumber非必须商品最低价
├─ now_pricenumber非必须当前价
├─ listobject非必须
├─ nicknamestring非必须砍价用户昵称
├─ avatarstring非必须砍价用户头像
├─ pricenumber非必须砍价金额
├─ bargain_pricenumber非必须已砍金额
├─ goods_namestring非必须商品名称
├─ cover_picstring非必须商品封面图
├─ goods_idnumber非必须商品ID
├─ goods_attr_idstring非必须商品规格ID

砍价基础设置

基本信息

Path: /bargain/api/index/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息

我的砍价

基本信息

Path: /bargain/api/order/bargain-list

Method: GET

接口描述:

我的砍价

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
page 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ goods_namestring必须商品名称
├─ cover_picstring必须商品封面图
├─ statusnumber必须砍价状态
├─ status_contentstring必须砍价状态说明
├─ contentstring必须砍价说明
├─ reset_timenumber必须剩余时间(秒)
├─ pricenumber必须商品价格
├─ min_pricenumber必须商品最低价
├─ now_pricenumber必须商品当前价
├─ typenumber必须是否允许中途购买
├─ finish_atstring必须砍价时间(日期格式)
├─ bargain_order_idstring必须砍价订单ID
├─ goods_idstring必须商品id
├─ goods_attr_idstring必须商品规格

积分商城

订单详情

基本信息

Path: /integral_mall/mall/order/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
order_id 是 1

商品放置首页

基本信息

Path: /integral_mall/mall/goods/switch-sell-well

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 134 商品ID

返回数据

名称类型是否必须默认值备注其他信息

订单列表

基本信息

Path: /integral_mall/mall/order/index

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Accept application/json 是

Query

参数名称 是否必须 示例 备注
page 否 1 分页、其它相关参数和商城订单同步

返回数据

名称类型是否必须默认值备注其他信息

积分商城设置

基本信息

Path: /integral_mall/mall/setting/index

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
form[desc] text 是 [[title:标题,content:内容],] 积分说明

返回数据

名称类型是否必须默认值备注其他信息

删除优惠券

基本信息

Path: /integral_mall/mall/coupon/destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 1 优惠券ID

清空回收站

基本信息

Path: /integral_mall/mall/order/destroy-all

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

用户兑换券列表

基本信息

Path: /integral_mall/mall/couponUser/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1

轮播图列表

基本信息

Path: /integral_mall/mall/banner/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页

添加轮播图

基本信息

Path: /integral_mall/mall/banner/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
ids text 是 [1,2,3] 轮播图ID数组

商品列表

基本信息

Path: /integral_mall/mall/goods/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页
search 否 {keyword:'商品名称'} 搜索条件

添加商品

基本信息

Path: /integral_mall/mall/goods/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
form[integral_num] text 否 1000 无规格时,兑换所需积分,多规格时需添加多规格积分价

返回数据

名称类型是否必须默认值备注其他信息

商品删除

基本信息

Path: /integral_mall/mall/goods/destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 商品ID

商品详情

基本信息

Path: /integral_mall/mall/goods/edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 30 商品ID

优惠券列表

基本信息

Path: /integral_mall/mall/coupon/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1

添加优惠券

基本信息

Path: /integral_mall/mall/coupon/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 否 1 列表ID
coupon_id text 否 1 商城优惠券ID
exchange_num text 是 10 用户可兑换总数
integral_num text 是 10 多少积分兑换
send_count text 是 100 优惠券发放总数
price text 是 10 优惠券价格

返回数据

名称类型是否必须默认值备注其他信息

积分商城-插件

分类商品列表

基本信息

Path: /plugin/integral_mall/api/goods/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cat_id 否 51 分类ID,不填写则返回全部
page 是 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须商品ID
├─ mall_idstring必须商城ID
├─ mch_idstring必须商户ID
├─ goods_warehouse_idstring必须关联商品库ID
├─ statusstring必须上架状态:0=下架,1=上架
├─ pricestring必须售价
├─ use_attrstring必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring必须商品规格组
├─ goods_stockstring必须商品总库存(规格库存相加)
├─ virtual_salesstring必须已出售量(虚拟销量)
├─ confine_countstring必须购物数量限制
├─ piecesstring必须单品满件包邮
├─ foreheadstring必须单口满额包邮
├─ freight_idstring必须运费模板ID
├─ give_integralstring必须赠送积分
├─ give_integral_typestring必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring必须可抵扣积分
├─ forehead_integral_typestring必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring必须允许多件累计折扣
├─ individual_sharestring必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring必须是否享受会员价购买
├─ is_level_alonestring必须是否单独设置会员价
├─ share_typestring必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring必须商品标示用于区分商品属于什么模块
├─ app_share_picstring必须商品自定义分享图片
├─ app_share_titlestring必须商品自定义分享标题
├─ is_default_servicesstring必须默认服务 0.否|1.是
├─ sortstring必须商品排序
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ payment_peoplestring必须统计 支付人数
├─ payment_numstring必须统计 支付件数
├─ payment_amountstring必须统计 支付金额
├─ payment_orderstring必须支付订单数
├─ confine_order_countstring必须限制下单数量
├─ is_area_limitstring必须是否单独区域购买
├─ area_limitstring必须区域限制详情 json格式
├─ share_level_typestring必须合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_idstring必须自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ goodsWarehouseobject必须
├─ idstring非必须商品库商品ID
├─ mall_idstring非必须商城ID
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ cost_pricestring非必须成本价
├─ detailstring非必须商品详情json
├─ cover_picstring非必须商品缩略图
├─ pic_urlstring非必须商品轮播图
├─ video_urlstring非必须商品视频
├─ unitstring非必须商品单位
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attrobject []必须

item 类型: object

├─ idstring必须
├─ goods_idstring必须
├─ sign_idstring必须
├─ stockstring必须
├─ pricestring必须
├─ nostring必须
├─ weightstring必须
├─ pic_urlstring必须
├─ is_deletestring必须
├─ integral_numstring必须
├─ integralMallGoodsobject必须
├─ idstring非必须
├─ goods_idstring非必须商品ID
├─ mall_idstring非必须商城ID
├─ is_homestring非必须是否放置首页0.否|1.是
├─ integral_numstring非必须商品所需积分
├─ is_deletestring非必须
├─ cover_picstring必须商品缩略图
├─ namestring必须商品名称
├─ original_pricestring必须商品原价
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

优惠券兑换列表

基本信息

Path: /plugin/integral_mall/api/coupon-order/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 分页

返回数据

名称类型是否必须默认值备注其他信息
object []非必须

item 类型: object

├─ idstring必须兑换记录ID
├─ user_idstring必须用户ID
├─ mall_idstring必须商城ID
├─ order_nostring必须订单号
├─ integral_mall_coupon_idstring必须积分优惠券ID
├─ integral_mall_coupon_infostring必须购买的优惠券信息
├─ user_coupon_idstring必须用户优惠券ID
├─ pricestring必须价格
├─ integral_numstring必须兑换所需积分
├─ is_paystring必须订单是否支付
├─ pay_timestring必须支付时间
├─ pay_typestring必须订单支付类型
├─ tokenstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ integralCouponobject必须优惠券信息
├─ idstring非必须积分商城优惠券ID
├─ mall_idstring非必须商城ID
├─ coupon_idstring非必须优惠券ID
├─ exchange_numstring非必须兑换次数限制
├─ integral_numstring非必须兑换所需积分
├─ send_countstring非必须发放总数
├─ pricestring非必须价格
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ couponobject非必须优惠券基本信息
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须优惠券名称
├─ typestring非必须优惠券类型:1=折扣,2=满减
├─ discountstring非必须折扣率
├─ pic_urlstring非必须
├─ descstring非必须
├─ min_pricestring非必须最低消费金额
├─ sub_pricestring非必须优惠金额
├─ total_countstring非必须发放总数量
├─ sortstring非必须排序按升序排列
├─ expire_typestring非必须到期类型:1=领取后N天过期,2=指定有效期
├─ expire_daystring非必须有效天数,expire_type=1时
├─ begin_timestring非必须有效期开始时间
├─ end_timestring非必须有效期结束时间
├─ appoint_typestring非必须1 指定分类 2 指定商品 3全部
├─ rulestring非必须使用说明
├─ is_memberstring非必须是否指定会员等级
├─ is_deletestring非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须

优惠券列表

基本信息

Path: /plugin/integral_mall/api/coupon/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须列表ID
├─ mall_idstring必须商城ID
├─ coupon_idstring必须优惠券ID
├─ exchange_numstring必须兑换次数-1.不限制
├─ integral_numstring必须所需兑换积分
├─ send_countstring必须发放优惠券总数
├─ pricestring必须优惠券价格
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ couponobject必须
├─ idstring非必须优惠券ID
├─ mall_idstring非必须优惠券所属商城ID
├─ namestring非必须优惠券名称
├─ typestring非必须优惠券类型:1=折扣(暂时无用),2=满减
├─ discountstring非必须折扣率
├─ pic_urlstring非必须图片
├─ descstring非必须描述
├─ min_pricestring非必须最低消费金额
├─ sub_pricestring非必须抵扣金额
├─ total_countstring非必须发放总数量
├─ is_joinstring非必须是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sortstring非必须排序按升序排列
├─ expire_typestring非必须到期类型:1=领取后N天过期,2=指定有效期
├─ expire_daystring非必须有效天数,expire_type=1时
├─ begin_timestring非必须有效期开始时间
├─ end_timestring非必须有效期结束时间
├─ appoint_typestring非必须1 指定分类 2 指定商品 3--全场通用
├─ rulestring非必须使用说明
├─ is_deletestring非必须删除
├─ receive_countstring非必须领取的数量
├─ couponCatobject []非必须

item 类型: object

├─ idstring必须
├─ coupon_idstring必须优惠券ID
├─ cat_idstring必须分类ID
├─ is_deletestring必须
├─ couponGoodsstring []非必须

item 类型: string

├─ 非必须
├─ couponOrdersstring []必须

item 类型: string

├─ 非必须
├─ is_receivenumber必须是否已领取0.否|1.是
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

优惠券订单提交

基本信息

Path: /plugin/integral_mall/api/coupon-order/order-submit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是 FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW

Query

参数名称 是否必须 示例 备注
X-Access-Token 是 FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 优惠券ID

返回数据

名称类型是否必须默认值备注其他信息

优惠券订单支付

基本信息

Path: /plugin/integral_mall/api/coupon-order/order-pay-data

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
queue_id 是 订单队列ID
token 是 订单token

优惠券详情

基本信息

Path: /plugin/integral_mall/api/coupon/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 积分商城优惠券ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ couponobject非必须
├─ idstring非必须优惠券ID
├─ mall_idstring非必须所属商城ID
├─ namestring非必须优惠券名称
├─ typestring非必须优惠券类型:1=折扣(暂时无用),2=满减
├─ discountstring非必须折扣率
├─ pic_urlstring非必须
├─ descstring非必须
├─ min_pricestring非必须最低消费金额
├─ sub_pricestring非必须抵扣金额
├─ total_countstring非必须发放总数量
├─ is_joinstring非必须是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sortstring非必须排序按升序排列
├─ expire_typestring非必须到期类型:1=领取后N天过期,2=指定有效期
├─ expire_daystring非必须有效天数,expire_type=1时
├─ begin_timestring非必须有效期开始时间
├─ end_timestring非必须有效期结束时间
├─ appoint_typestring非必须1 指定分类 2 指定商品 3--全场通用
├─ rulestring非必须使用说明
├─ is_deletestring非必须删除
├─ catobject []非必须优惠券所属分类(appoint_type==1)

item 类型: object

├─ namestring必须分类名称
├─ goodsobject []非必须优惠券所属商品(appoint_type==2)

item 类型: object

├─ namestring必须商品名称
├─ is_receiveinteger非必须领取的数量

兑换商品详情

基本信息

Path: /integral_mall/api/order/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须订单ID
├─ mall_idnumber非必须商城ID
├─ user_idnumber非必须用户ID
├─ mch_idnumber非必须商户ID
├─ order_nostring非必须订单号
├─ total_pricestring非必须订单总金额(含运费)
├─ total_pay_pricestring非必须实际支付总费用(含运费)
├─ express_original_pricestring非必须运费(后台修改前)
├─ express_pricestring非必须运费(后台修改后)
├─ total_goods_pricestring非必须订单商品总金额(优惠后)
├─ total_goods_original_pricestring非必须订单商品总金额(优惠前)
├─ member_discount_pricestring非必须会员优惠价格(正数表示优惠,负数表示加价)
├─ use_user_coupon_idnumber非必须使用的用户优惠券id
├─ coupon_discount_pricestring非必须优惠券优惠金额
├─ use_integral_numnumber非必须使用积分数量
├─ integral_deduction_pricestring非必须积分抵扣金额
├─ namestring非必须收件人姓名
├─ mobilestring非必须收件人手机号
├─ addressstring非必须收件人地址
├─ remarkstring非必须用户订单备注
├─ order_formobject []非必须自定义表单(JSON)

item 类型: object

├─ keystring必须表单组件唯一标识
├─ labelstring必须表单名称
├─ valuestring,null必须表单值
├─ requirednumber必须表单组件是否必填
├─ wordsstring非必须商家留言
├─ seller_remarkstring非必须商家订单备注
├─ is_paynumber非必须是否支付:0.未支付|1.已支付
├─ pay_typenumber非必须支付方式:1.在线支付 2.货到付款 3.余额支付
├─ pay_timestring非必须支付时间
├─ is_sendnumber非必须是否发货:0.未发货|1.已发货
├─ send_timestring非必须发货时间
├─ customer_namestring非必须(已废弃)京东商家编号
├─ expressstring非必须(已废弃)物流公司
├─ express_nostring非必须(已废弃)物流订单号
├─ is_salenumber非必须是否过售后时间
├─ is_confirmnumber非必须收货状态:0.未收货|1.已收货
├─ confirm_timestring非必须确认收货时间
├─ cancel_statusnumber非必须订单取消状态:0.未取消|1.已取消|2.申请取消
├─ cancel_timestring非必须订单取消时间
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ is_recyclenumber非必须是否加入回收站 0.否|1.是
├─ send_typenumber非必须是否到店自提:0.否|1.是
├─ offline_qrcodestring非必须核销码
├─ clerk_idnumber非必须核销员ID
├─ store_idnumber非必须自提门店ID
├─ signstring非必须订单标识,用于区分插件
├─ tokenstring非必须订单所属队列标识
├─ support_pay_typesstring非必须支持的支付方式,空表示支持系统设置支持的所有方式
├─ is_commentnumber非必须是否评价0.否|1.是
├─ comment_timestring非必须评价时间
├─ sale_statusnumber非必须是否申请售后0.否|1.是
├─ statusnumber非必须订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_pricestring非必须后台优惠(正数表示优惠,负数表示加价)
├─ auto_cancel_timestring非必须自动取消时间
├─ auto_confirm_timenull,string非必须自动确认收货时间
├─ auto_sales_timenull,string非必须自动售后时间
├─ distancenumber非必须同城配送距离,-1不在范围内,正数为距离KM
├─ city_mobilestring非必须同城配送联系方式
├─ locationnull非必须同城配送用户经纬度
├─ city_namenull非必须城市名称
├─ city_infonull非必须城市信息
├─ detailobject []非必须

item 类型: object

├─ idnumber非必须商品详情ID
├─ order_idnumber非必须关联订单ID
├─ goods_idnumber非必须商品ID
├─ numnumber非必须商品数量
├─ unit_pricestring非必须商品单价
├─ total_original_pricestring非必须商品原总价(优惠前)
├─ total_pricestring非必须商品总价(优惠后)
├─ member_discount_pricestring非必须会员优惠金额(正数表示优惠,负数表示加价)
├─ goods_infoobject非必须商品信息josn格式
├─ namestring非必须商品名称
├─ attr_listobject []非必须已选规格信息

item 类型: object

├─ attr_group_namestring必须规格组名
├─ attr_group_idnumber必须规格组ID
├─ attr_idnumber必须规格ID
├─ attr_namestring必须规格名称
├─ pic_urlstring非必须商品缩略图
├─ numnumber非必须商品数量
├─ total_original_pricestring非必须商品总价(优惠前)
├─ member_discount_pricestring非必须会员折扣金额
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_refundnumber非必须商品是否退款
├─ refund_statusnumber非必须售后状态 0--未售后 1--售后中 2--售后结束
├─ back_pricestring非必须售后状态 0--未售后 1--售后中 2--售后结束
├─ signstring非必须订单详情标识,用于区分插件
├─ goods_nostring非必须商品货号
├─ integralOrderobject非必须
├─ idstring非必须积分商城订单ID
├─ mall_idstring非必须商城ID
├─ order_idstring非必须关联订单ID
├─ tokenstring非必须关联订单token
├─ integral_numstring非必须积分金额
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须

优惠券兑换详情

基本信息

Path: /plugin/integral_mall/api/coupon-order/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 订单ID

返回数据

名称类型是否必须默认值备注其他信息

商品兑换列表

基本信息

Path: /integral_mall/api/order/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须订单ID
├─ mall_idnumber必须商城ID
├─ user_idnumber必须用户ID
├─ mch_idnumber必须商户ID
├─ order_nostring必须订单号
├─ total_pricestring必须订单总金额(含运费)
├─ total_pay_pricestring必须实际支付总费用(含运费)
├─ express_original_pricestring必须运费(后台修改前)
├─ express_pricestring必须运费(后台修改后)
├─ total_goods_pricestring必须订单商品总金额(优惠后)
├─ total_goods_original_pricestring必须订单商品总金额(优惠前)
├─ member_discount_pricestring必须会员优惠价格(正数表示优惠,负数表示加价)
├─ use_user_coupon_idnumber必须使用的用户优惠券id
├─ coupon_discount_pricestring必须优惠券优惠金额
├─ use_integral_numnumber必须使用积分数量
├─ integral_deduction_pricestring必须积分抵扣金额
├─ namestring必须收件人姓名
├─ mobilestring必须收件人手机号
├─ addressstring必须收件人地址
├─ remarkstring必须用户订单备注
├─ order_formobject []必须自定义表单(JSON)

item 类型: object

├─ keystring必须表单组件唯一标识
├─ labelstring必须表单名称
├─ valuestring,null必须表单值
├─ requirednumber必须表单组件是否必填
├─ wordsstring必须商家留言
├─ seller_remarkstring必须商家订单备注
├─ is_paynumber必须是否支付:0.未支付|1.已支付
├─ pay_typenumber必须支付方式:1.在线支付 2.货到付款 3.余额支付
├─ pay_timestring必须支付时间
├─ is_sendnumber必须是否发货:0.未发货|1.已发货
├─ send_timestring必须发货时间
├─ customer_namestring必须(已废弃)京东商家编号
├─ expressstring必须(已废弃)物流公司
├─ express_nostring必须(已废弃)物流订单号
├─ is_salenumber必须是否过售后时间
├─ is_confirmnumber必须收货状态:0.未收货|1.已收货
├─ confirm_timestring必须确认收货时间
├─ cancel_statusnumber必须订单取消状态:0.未取消|1.已取消|2.申请取消
├─ cancel_timestring必须订单取消时间
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ is_recyclenumber必须是否加入回收站 0.否|1.是
├─ send_typenumber必须是否到店自提:0.否|1.是
├─ offline_qrcodestring必须核销码
├─ clerk_idnumber必须核销员ID
├─ store_idnumber必须自提门店ID
├─ signstring必须订单标识,用于区分插件
├─ tokenstring必须订单所属队列标识
├─ support_pay_typesstring必须支持的支付方式,空表示支持系统设置支持的所有方式
├─ is_commentnumber必须是否评价0.否|1.是
├─ comment_timestring必须评价时间
├─ sale_statusnumber必须是否申请售后0.否|1.是
├─ statusnumber必须订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_pricestring必须后台优惠(正数表示优惠,负数表示加价)
├─ auto_cancel_timestring必须自动取消时间
├─ auto_confirm_timenull,string必须自动确认收货时间
├─ auto_sales_timenull,string必须自动售后时间
├─ distancenumber必须同城配送距离,-1不在范围内,正数为距离KM
├─ city_mobilestring必须同城配送联系方式
├─ locationnull必须同城配送用户经纬度
├─ city_namenull必须城市名称
├─ city_infonull必须城市信息
├─ detailobject []必须

item 类型: object

├─ idstring必须
├─ order_idstring必须
├─ goods_idstring必须
├─ numstring必须
├─ unit_pricestring必须
├─ total_original_pricestring必须
├─ total_pricestring必须
├─ member_discount_pricestring必须
├─ goods_infoobject必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ goods_attrobject非必须
├─ idnumber非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stocknumber非必须
├─ pricestring非必须
├─ original_pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ share_commission_firststring非必须
├─ share_commission_secondstring非必须
├─ share_commission_thirdstring非必须
├─ individual_sharenumber非必须
├─ share_typenumber非必须
├─ member_pricenull非必须
├─ integral_pricenull非必须
├─ use_integralnull非必须
├─ discountstring []非必须

item 类型: string

├─ 非必须
├─ extraobject非必须
├─ integral_numnumber非必须
├─ goods_warehouse_idnumber非必须
├─ namestring非必须
├─ cover_picstring非必须
├─ detailstring非必须
├─ pic_liststring非必须
├─ numbernumber非必须
├─ namestring非必须
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_refundstring必须
├─ refund_statusstring必须
├─ back_pricestring必须
├─ signstring必须
├─ goods_nostring必须
├─ goodsobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ mch_idstring非必须
├─ goods_warehouse_idstring非必须
├─ statusstring非必须
├─ pricestring非必须
├─ use_attrstring非必须
├─ attr_groupsstring非必须
├─ goods_stockstring非必须
├─ virtual_salesstring非必须
├─ confine_countstring非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ freight_idstring非必须
├─ give_integralstring非必须
├─ give_integral_typestring非必须
├─ forehead_integralstring非必须
├─ forehead_integral_typestring非必须
├─ accumulativestring非必须
├─ individual_sharestring非必须
├─ attr_setting_typestring非必须
├─ is_levelstring非必须
├─ is_level_alonestring非必须
├─ share_typestring非必须
├─ signstring非必须
├─ app_share_picstring非必须
├─ app_share_titlestring非必须
├─ is_default_servicesstring非必须
├─ sortstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须
├─ payment_numstring非必须
├─ payment_amountstring非必须
├─ payment_orderstring非必须
├─ confine_order_countstring非必须
├─ is_area_limitstring非必须
├─ area_limitstring非必须
├─ share_level_typestring非必须
├─ form_idstring非必须
├─ goodsWarehouseobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ original_pricestring非必须
├─ cost_pricestring非必须
├─ detailstring非必须
├─ cover_picstring非必须
├─ pic_urlstring非必须
├─ video_urlstring非必须
├─ unitstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ integralOrderobject必须
├─ idstring非必须
├─ mall_idstring非必须
├─ order_idstring非必须订单ID
├─ tokenstring非必须订单token
├─ integral_numstring非必须商品所需积分
├─ is_deletestring非必须
├─ created_atstring非必须
├─ deleted_atstring非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

商品分类列表

基本信息

Path: /plugin/integral_mall/api/goods/cats

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须分类ID
├─ mall_idstring必须商城ID
├─ mch_idstring必须商户ID
├─ parent_idstring必须父级ID
├─ namestring必须分类名称
├─ pic_urlstring必须分类图片
├─ sortstring必须排序,升序
├─ big_pic_urlstring必须分类大图
├─ advert_picstring必须广告大图 用于分类广告
├─ advert_urlstring必须广告跳转rul
├─ statusstring必须是否启用:0.禁用|1.启用
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_showstring必须分类是否显示0.否|1.是

商品详情

基本信息

Path: /plugin/integral_mall/api/goods/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 61 商品ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idstring非必须商品ID
├─ mall_idstring非必须商城ID
├─ mch_idstring非必须商户ID
├─ goods_warehouse_idstring非必须关联商品库ID
├─ statusstring非必须上架状态:0=下架,1=上架
├─ pricestring非必须售价
├─ use_attrstring非必须是否使用规格:0=不使用,1=使用
├─ attr_groupsstring非必须商品规格组
├─ goods_stockstring非必须商品总库存(规格库存相加)
├─ virtual_salesstring非必须已出售量(虚拟销量)
├─ confine_countstring非必须购物数量限制
├─ piecesstring非必须单品满件包邮
├─ foreheadstring非必须单口满额包邮
├─ freight_idstring非必须运费模板ID
├─ give_integralstring非必须赠送积分
├─ give_integral_typestring非必须赠送积分类型1.固定值 |2.百分比
├─ forehead_integralstring非必须可抵扣积分
├─ forehead_integral_typestring非必须可抵扣积分类型1.固定值 |2.百分比
├─ accumulativestring非必须允许多件累计折扣
├─ individual_sharestring非必须是否单独合伙人设置:0=否,1=是
├─ attr_setting_typestring非必须合伙人设置类型 0.普通设置|1.详细设置
├─ is_levelstring非必须是否享受会员价购买
├─ is_level_alonestring非必须是否单独设置会员价
├─ share_typestring非必须合伙人佣金配比 0--固定金额 1--百分比
├─ signstring非必须商品标示用于区分商品属于什么模块
├─ app_share_picstring非必须商品自定义分享图片
├─ app_share_titlestring非必须商品自定义分享标题
├─ is_default_servicesstring非必须默认服务 0.否|1.是
├─ sortstring非必须商品排序
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ payment_peoplestring非必须统计 支付人数
├─ payment_numstring非必须统计 支付件数
├─ payment_amountstring非必须统计 支付金额
├─ payment_orderstring非必须支付订单数
├─ confine_order_countstring非必须限制下单数量
├─ is_area_limitstring非必须是否单独区域购买
├─ area_limitstring非必须区域限制详情 json格式
├─ share_level_typestring非必须合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_idstring非必须自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ namestring非必须商品名称
├─ original_pricestring非必须商品原价
├─ cover_picstring非必须商品缩略图
├─ unitstring非必须商品单位
├─ detailstring非必须商品详情
├─ video_urlstring非必须商品视频url
├─ level_shownumber非必须显示会员价0.不显示|1.是当前用户会员价|2.下一级会员价
├─ is_salesnumber非必须是否显示销量0.否|1.是
├─ attrobject []非必须

item 类型: object

├─ idnumber非必须
├─ goods_idnumber非必须
├─ sign_idstring非必须
├─ stocknumber非必须
├─ pricestring非必须
├─ nostring非必须
├─ weightnumber非必须
├─ pic_urlstring非必须
├─ is_deletenumber非必须
├─ attr_listobject []非必须

item 类型: object

├─ attr_group_namestring非必须
├─ attr_group_idnumber非必须
├─ attr_idnumber非必须
├─ attr_namestring非必须
├─ price_membernumber非必须
├─ member_price_listobject []非必须

item 类型: object

├─ idnumber非必须
├─ levelnumber非必须
├─ pricestring非必须
├─ goods_attr_idnumber非必须
├─ is_deletenumber非必须
├─ goods_idnumber非必须
├─ integral_numstring非必须
├─ extraobject非必须
├─ valuestring非必须
├─ namestring非必须
├─ goods_numnumber非必须商品库存
├─ goods_nostring非必须商品货号
├─ goods_weightnumber非必须商品重量
├─ servicesstring []非必须商品服务

item 类型: string

├─ 非必须
├─ cardsstring []非必须

item 类型: string

├─ 非必须
├─ price_minnumber非必须商品规格最小价
├─ price_maxnumber非必须商品规格最大价
├─ pic_urlobject []非必须商品轮播图

item 类型: object

├─ idstring非必须
├─ pic_urlstring非必须
├─ sharenumber非必须合伙人金额
├─ salesnumber非必须销量
├─ favoriteboolean非必须
├─ goods_marketingobject非必须
├─ limitstring非必须
├─ pickupstring非必须
├─ shippingstring非必须
├─ goods_marketing_awardobject非必须
├─ cardobject非必须
├─ titlestring非必须
├─ liststring []非必须

item 类型: string

├─ 非必须
├─ integralobject非必须
├─ titlestring非必须
├─ vip_card_appointobject非必须
├─ discountnull非必须折扣
├─ is_my_vip_card_goodsnumber非必须登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_usernumber非必须登录用户是不是会员 1是 0否
├─ integralMallGoodsobject非必须
├─ idnumber非必须积分商城商品ID
├─ goods_idnumber非必须商品ID
├─ mall_idnumber非必须商城ID
├─ is_homenumber非必须是否放置首页0.否|1.是
├─ integral_numnumber非必须商品所属积分
├─ is_deletenumber非必须

积分商城首页

基本信息

Path: /plugin/integral_mall/api/index/index

Method: GET

接口描述:

跳转方式参数说明
app跳转
    app_id    跳转小程序的appID
    path    跳转的小程序页面

tel 跳转
    tel    联系电话

web 跳转
    url    跳转网页路径

contact 跳转

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ bannersobject []非必须轮播图列表

item 类型: object

├─ idstring必须轮播图ID
├─ mall_idstring必须商城ID
├─ pic_urlstring必须图片
├─ titlestring必须标题
├─ page_urlstring必须跳转页面url
├─ open_typestring必须打开方式:redirect 重定向跳转|navigate普通跳转|app 跳转小程序|contact 客服| clear_cache 清除缓存| tel 拔打电话|web 跳转网页
├─ paramsstring必须导航参数
├─ is_deletestring必须
├─ created_atstring必须
├─ deleted_atstring必须
├─ updated_atstring必须
├─ settingobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ is_sharenumber非必须
├─ is_smsnumber非必须
├─ is_mailnumber非必须
├─ is_printnumber非必须
├─ is_territorial_limitationnumber非必须
├─ descobject []非必须

item 类型: object

├─ titlestring必须
├─ contentstring必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ payment_typestring []非必须

item 类型: string

├─ 非必须
├─ send_typestring []非必须

item 类型: string

├─ 非必须
├─ goods_posterobject非必须
├─ bg_picobject非必须
├─ urlstring非必须
├─ picobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ headobject非必须
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_typestring非必须
├─ nicknameobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ nickname_shareobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ poster_bgobject非必须
├─ is_shownumber非必须
├─ widthnumber非必须
├─ heightnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ qr_codeobject非必须
├─ is_shownumber非必须
├─ sizenumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ typenumber非必须
├─ file_pathstring非必须
├─ file_typestring非必须
├─ nameobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ descobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ textstring非必须
├─ colorstring非必须
├─ file_typestring非必须
├─ widthnumber非必须
├─ priceobject非必须
├─ is_shownumber非必须
├─ fontnumber非必须
├─ topnumber非必须
├─ leftnumber非必须
├─ colorstring非必须
├─ textstring非必须
├─ file_typestring非必须
├─ userInfoobject非必须
├─ integralnumber非必须

积分明细列表

基本信息

Path: /api/integral-log/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1
type 是 1 类型 1.收入(默认)

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须积分明细ID
├─ mall_idstring必须商城ID
├─ user_idstring必须用户ID
├─ typestring必须类型:1=收入,2=支出
├─ integralstring必须变动积分
├─ descstring必须变动说明
├─ custom_descstring必须自定义详细说明|记录
├─ created_atstring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

订单提交

基本信息

Path: /plugin/integral_mall/api/order/order-submit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

订单预览

基本信息

Path: /plugin/integral_mall/api/order/order-preview

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

coupon

优惠券列表

基本信息

Path: /coupon/list

Method: GET

接口描述:

加入领券中心的优惠券列表

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token 是 FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW token

Query

参数名称 是否必须 示例 备注
page 否 1 分页数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须0
msgstring非必须
dataobject非必须
├─ list object []非必须优惠券列表

item 类型: object

├─ idstring必须优惠券ID
├─ mall_idstring必须所属商城ID
├─ namestring必须优惠券名称
├─ typestring必须优惠券类型:1=折扣(暂时无用),2=满减
├─ discountstring必须折扣率
├─ pic_urlstring必须
├─ descstring必须
├─ min_pricestring必须最低消费金额
├─ sub_pricestring必须抵扣金额
├─ total_countstring必须发放总数量
├─ is_joinstring必须是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sortstring必须排序按升序排列
├─ expire_typestring必须到期类型:1=领取后N天过期,2=指定有效期
├─ expire_daystring必须有效天数,expire_type=1时
├─ begin_timestring必须有效期开始时间
├─ end_timestring必须有效期结束时间
├─ appoint_typestring必须1 指定分类 2 指定商品 3--全场通用
├─ rulestring必须使用说明
├─ is_deletestring必须删除
├─ catobject []非必须优惠券所属分类(appoint_type==1)

item 类型: object

├─ namestring必须分类名称
├─ goodsobject []非必须优惠券所属商品(appoint_type==2)

item 类型: object

├─ namestring必须商品名称
├─ is_receiveinteger必须领取的数量

优惠券海报

基本信息

Path: /coupon/give-poster

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
user_coupon_id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ idnumber非必须优惠券id
├─ namestring非必须优惠券名称
├─ typenumber非必须优惠券类型
├─ discountstring非必须优惠券折扣
├─ discount_limitnull非必须优惠上限
├─ min_pricestring非必须门槛
├─ sub_pricestring非必须满减金额
├─ expire_typenumber非必须到期类型:1=领取后N天过期,2=指定有效期
├─ expire_daynumber非必须有效天数,expire_type=1时
├─ begin_timestring非必须有效期开始时间
├─ end_timestring非必须有效期结束时间
├─ appoint_typestring非必须类型
├─ avatarstring非必须头像
├─ nicknamestring非必须昵称
├─ qrcodestring非必须二维码

优惠券详情

基本信息

Path: /coupon/detail

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是 FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW token

Query

参数名称 是否必须 示例 备注
coupon_id 是 1 优惠券ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject非必须
├─ idstring非必须优惠券ID
├─ mall_idstring非必须优惠券所属商城ID
├─ namestring非必须优惠券名称
├─ typestring非必须优惠券类型:1=折扣(暂时无用),2=满减
├─ discountstring非必须折扣率
├─ pic_urlstring非必须
├─ descstring非必须
├─ min_pricestring非必须最低消费金额
├─ sub_pricestring非必须抵扣金额
├─ total_countstring非必须发放总数量
├─ is_joinstring非必须是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sortstring非必须排序按升序排列
├─ expire_typestring非必须到期类型:1=领取后N天过期,2=指定有效期
├─ expire_daystring非必须有效天数,expire_type=1时
├─ begin_timestring非必须有效期开始时间
├─ end_timestring非必须有效期结束时间
├─ appoint_typestring非必须1 指定分类 2 指定商品 3--全场通用
├─ rulestring非必须使用说明
├─ is_deletestring非必须删除
├─ receive_countstring非必须领取的数量
├─ catobject []非必须优惠券所属分类(appoint_type==1)

item 类型: object

├─ namestring非必须分类名称
├─ goodsobject []非必须优惠券所属商品(appoint_type==2)

item 类型: object

├─ namestring非必须商品名称

优惠券领取

基本信息

Path: /coupon/receive

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是 FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW

Query

参数名称 是否必须 示例 备注
coupon_id 是 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须0--成功 1--失败
msgstring非必须

分享获得优惠券

基本信息

Path: /coupon/share-coupon

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息

我的优惠券

基本信息

Path: /coupon/user-coupon

Method: GET

接口描述:

我的优惠券列表

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
status 是 1、2、3 状态 1--未使用 2--已使用 3--已过期

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须用户优惠券ID
├─ mall_idstring必须商城ID
├─ user_idstring必须用户ID
├─ coupon_idstring必须优惠券ID
├─ coupon_min_pricestring必须最低消费金额
├─ start_timestring必须开始时间
├─ end_timestring必须结束时间
├─ is_usestring必须是否使用 0--未使用 1--已使用
├─ is_deletestring必须是否删除 0--未删除 1--已删除
├─ created_atstring必须创建时间
├─ updated_atstring必须更新时间
├─ deleted_atstring必须删除时间
├─ receive_typestring必须获取方式
├─ coupon_datastring必须优惠券信息
├─ couponobject必须优惠券详情
├─ idstring非必须优惠券ID
├─ mall_idstring非必须
├─ namestring非必须优惠券名称
├─ typestring非必须优惠券类型:1=折扣,2=满减
├─ discountstring非必须折扣率
├─ sub_pricestring非必须优惠金额
├─ pic_urlstring非必须
├─ descstring非必须
├─ total_countstring非必须发放总数量
├─ is_joinstring非必须是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ appoint_typestring非必须1 指定商品 2 指定商品 3全部
├─ rulestring非必须优惠券使用说明
├─ catobject []非必须优惠券指定分类

item 类型: object

├─ namestring必须分类名称
├─ goodsobject []非必须

item 类型: object

├─ namestring必须商品名称

我的优惠券详情

基本信息

Path: /coupon/user-coupon-detail

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
user_coupon_id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject非必须
├─ sub_pricestring非必须优惠金额
├─ discountstring非必须优惠折扣
├─ coupon_min_pricestring非必须最低消费金额
├─ typenumber非必须优惠券类型:1=折扣,2=满减
├─ start_timestring非必须有效期开始时间
├─ end_timestring非必须有效期结束时间
├─ is_usenumber非必须是否已使用:0=未使用,1=已使用
├─ is_expirednumber非必须是否已过期:0=未过期,1=已过期
├─ receive_typestring非必须获取来源
├─ namestring非必须优惠券名称
├─ pic_urlnumber非必须优惠券图片
├─ descstring非必须
├─ rulestring非必须使用说明
├─ appoint_typestring非必须指定方式1--指定分类 2--指定商品 3--通用
├─ goodsstring []非必须指定商品名称集合

item 类型: string

├─ 非必须
├─ catstring []非必须指定分类集合

item 类型: string

├─ 非必须

收藏

取消商品收藏

基本信息

Path: /user/favorite-remove

Method: GET

接口描述:

用户取消商品收藏

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
goods_id 是 8 商品ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须返回码 0--成功 1--失败
msgstring非必须安徽说明
databoolean必须true--添加收藏 false--取消收藏

我的收藏分类

基本信息

Path: /api/user/favorite-cats

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ namestring必须

我的收藏列表(商品)

基本信息

Path: /user/my-new-favorite-goods

Method: GET

接口描述:

我的收藏列表(商品)

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
page 否 1
cat_id 否 16090 分类id
status 否 2 1:低库存
2:已失效
3:降价

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ goodsobject必须
├─ idnumber非必须商品ID
├─ goods_warehouse_idnumber非必须商品库id
├─ mch_idnumber非必须
├─ signstring非必须插件标识
├─ namestring非必须商品名称
├─ cover_picstring非必须
├─ video_urlstring非必须
├─ original_pricestring非必须
├─ unitstring非必须
├─ page_urlstring非必须
├─ is_negotiablenumber非必须
├─ is_levelnumber非必须
├─ level_pricenumber非必须
├─ pricestring非必须
├─ price_contentstring非必须
├─ is_salesstring非必须
├─ salesstring非必须
├─ attr_groupsobject []非必须

item 类型: object

├─ attr_group_idnumber必须
├─ attr_group_namestring必须
├─ attr_listobject []必须

item 类型: object

├─ attr_idnumber必须
├─ attr_namestring必须
├─ attrobject []非必须

item 类型: object

├─ idnumber必须
├─ goods_idnumber必须
├─ sign_idstring必须
├─ stocknumber必须
├─ pricestring必须
├─ nostring必须
├─ weightnumber必须
├─ pic_urlstring必须
├─ is_deletenumber必须
├─ attr_listobject []必须

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ goods_stocknumber非必须
├─ goods_numnumber非必须
├─ vip_card_appointobject非必须
├─ discountnull,string非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ is_invalidboolean非必须是否失效
├─ is_low_priceboolean非必须是否降价
├─ is_low_stockboolean非必须是否低库存

我的收藏(专题)

基本信息

Path: /user/my-favorite-topic

Method: GET

接口描述:

我的收藏(专题)

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
x-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
page 是 分页数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须专题ID
├─ mall_idstring非必须
├─ typestring非必须专题分类
├─ titlestring非必须专题标题
├─ sub_titlestring非必须副标题
├─ contentstring非必须专题内容
├─ layoutstring非必须布局方式:0=小图,1=大图模式
├─ sortstring非必须排序
├─ cover_picstring非必须封面图
├─ read_countstring非必须阅读数
├─ agree_countstring非必须点赞数
├─ virtual_read_countstring非必须虚拟阅读数
├─ virtual_agree_countstring非必须虚拟点赞数
├─ virtual_favorite_countstring非必须虚拟收藏数
├─ qrcode_picstring非必须
├─ is_chosenstring非必须
├─ is_deletestring非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ goods_countnumber非必须商品数

批量取消收藏

基本信息

Path: /api/user/favorite-batch-remove

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
goods_ids[] text 是 74200 收藏的商品id,是个数组

返回数据

名称类型是否必须默认值备注其他信息

添加商品收藏

基本信息

Path: /user/favorite-add

Method: GET

接口描述:

用户添加商品收藏

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
goods_id 是 8 商品ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须返回码 0--成功 1--失败
msgstring非必须返回说明
databoolean非必须true--添加收藏 false--取消收藏

文章

文章列表

基本信息

Path: /default/article-list

Method: GET

接口描述:

文章列表

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须文章列表

item 类型: object

├─ idstring非必须文章ID
├─ mall_idstring非必须商城ID
├─ article_cat_idstring非必须文章分类ID 1--关于我们 2--服务中心
├─ titlestring非必须文章标题
├─ contentstring非必须文章内容 html格式
├─ sortstring非必须文章排序
├─ is_deletestring非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须

文章详情

基本信息

Path: /default/article

Method: GET

接口描述:

文章详情

请求参数

Query

参数名称 是否必须 示例 备注
article_id 是 1 文章ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ articleobject非必须
├─ idstring非必须文章ID
├─ mall_idstring非必须商城ID
├─ article_cat_idstring非必须文章分类ID 1--关于我们 2--服务中心
├─ titlestring非必须文章标题
├─ contentstring非必须文章内容html格式
├─ sortstring非必须文章排序
├─ is_deletestring非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须

快速购买

分类商品

基本信息

Path: /quick/good-list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ countstring非必须购物车数量
├─ listobject []非必须商品信息

item 类型: object

├─ idnumber必须
├─ cover_picstring必须封面图
├─ namestring必须商品名称
├─ virtual_salesnumber必须销量
├─ pricestring必须价格
├─ use_attrnumber必须是否使用规格1:开启 0关闭
├─ cartstring []必须购物车数据

item 类型: string

├─ 非必须
├─ attrobject []必须规格数据

item 类型: object

├─ idnumber必须
├─ goods_idnumber必须
├─ sign_idstring必须
├─ stocknumber必须
├─ pricestring必须
├─ nostring必须
├─ weightnumber必须
├─ pic_urlstring必须
├─ is_deletenumber必须
├─ attr_listobject []必须

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ price_membernumber必须
├─ member_price_listobject []必须

item 类型: object

├─ idnumber必须
├─ levelnumber必须
├─ pricestring必须
├─ goods_attr_idnumber必须
├─ is_deletenumber必须
├─ goods_idnumber必须
├─ member_price_2number必须
├─ member_price_3number必须
├─ goods_numnumber必须商品总数
├─ total_numnumber必须
├─ attr_groupsobject []必须规格组信息

item 类型: object

├─ attr_group_idnumber必须
├─ attr_group_namestring必须
├─ attr_listobject []必须

item 类型: object

├─ attr_idnumber必须
├─ attr_namestring必须
├─ is_levelnumber必须是否启用会员价 0关闭 1开启
├─ level_shownumber必须是否显示会员价
├─ level_pricenumber必须会员价
├─ vip_card_appointobject必须
├─ discountstring,null非必须折扣
├─ is_my_vip_card_goodsnumber非必须是否超级vip商品
├─ is_vip_card_usernumber非必须是否vip用户

快速购买首页

基本信息

Path: /quick/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ countstring非必须购物车数量
├─ cats_listobject []非必须分类列表

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ parent_idstring必须父级id
├─ namestring必须分类名称
├─ pic_urlstring必须分类图片
├─ sortstring必须排序
├─ big_pic_urlstring必须大图: 分类图
├─ advert_picstring必须广告图
├─ advert_urlstring必须广告跳转路径
├─ statusstring必须状态 0关 1开启
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_showstring必须0 不显示 1显示
├─ hot_liststring []非必须已删除

item 类型: string

├─ 非必须

购物车

基本信息

Path: /quick/cart

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token 0DBfMLNTV2H_EqWr1fn7zowiROUfwind 是

Body

参数名称 参数类型 是否必须 示例 备注
list text 是 [{"attr":"72","num":1,"good_id":"17"}] 改动购物车

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

收货地址

地址保存

基本信息

Path: /user/address-save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token 0DBfMLNTV2H_EqWr1fn7zowiROUfwind 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 1 收货人
province_id text 是 1 省
city_id text 是 3 市
district_id text 是 4 区
mobile text 是 18282828282 号码
detail text 是 北京朝阳 地址详情
id text 否 1 地址id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

地址删除

基本信息

Path: /user/address-destroy

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 1 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

地址详情

基本信息

Path: /user/address-detail

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token 0DBfMLNTV2H_EqWr1fn7zowiROUfwind 是

Query

参数名称 是否必须 示例 备注
id 是 1 地址id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ idnumber非必须
├─ user_idnumber非必须
├─ namestring非必须
├─ province_idnumber非必须
├─ provincestring非必须省
├─ city_idnumber非必须
├─ citystring非必须市
├─ district_idnumber非必须
├─ districtstring非必须县
├─ mobilestring非必须
├─ detailstring非必须详细地址
├─ is_defaultnumber非必须是否默认
├─ is_deletenumber非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须

地址默认

基本信息

Path: /user/address-default

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token 0DBfMLNTV2H_EqWr1fn7zowiROUfwind 是

Body

参数名称 参数类型 是否必须 示例 备注
is_default text 是 1 是否默认
id text 是 1 地址id

返回数据

名称类型是否必须默认值备注其他信息

微信省市区

基本信息

Path: /user/wechat-district

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
province_name 是 北京市 省
city_name 是 北京市 市
county_name 是 朝阳区 区

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ districtobject非必须
├─ provinceobject非必须省
├─ idnumber非必须
├─ namestring非必须
├─ cityobject非必须市
├─ idnumber非必须
├─ namestring非必须
├─ districtobject非必须区
├─ idnumber非必须
├─ namestring非必须

用户收货首页

基本信息

Path: /user/address

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1 页码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须收货列表

item 类型: object

├─ idstring必须
├─ user_idstring必须
├─ namestring必须收货人
├─ province_idstring必须
├─ provincestring必须省份名称
├─ city_idstring必须
├─ citystring必须城市名称
├─ district_idstring必须
├─ districtstring必须县区名称
├─ mobilestring必须
├─ detailstring必须详细地址
├─ is_defaultstring必须是否默认
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ addressstring必须省市区拼接

default

3级分类

基本信息

Path: /cat/goods

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cat_id 是 123 3级分类id
cat_ids 是 [1,3,4,123] 3级分类组
offset 是 0 偏移量

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须
├─ mch_idnumber必须
├─ parent_idnumber必须
├─ namestring必须
├─ pic_urlstring必须
├─ sortnumber必须
├─ big_pic_urlstring必须
├─ advert_picstring必须
├─ advert_urlstring必须
├─ statusnumber必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ is_shownumber必须
├─ advert_open_typestring必须
├─ advert_paramsstring必须
├─ goods_listobject []必须

item 类型: object

├─ idnumber必须
├─ goods_warehouse_idnumber必须
├─ mch_idnumber必须
├─ signstring必须
├─ namestring必须
├─ cover_picstring必须
├─ video_urlstring必须
├─ original_pricestring必须
├─ unitstring必须
├─ page_urlstring必须
├─ is_negotiablenumber必须
├─ is_levelnumber必须
├─ level_pricenumber必须
├─ pricestring必须
├─ price_contentstring必须
├─ is_salesstring必须
├─ salesstring必须
├─ attr_groupsobject []必须

item 类型: object

├─ attr_group_idnumber必须
├─ attr_group_namestring必须
├─ attr_listobject []必须

item 类型: object

├─ attr_idnumber必须
├─ attr_namestring必须
├─ pic_urlstring必须
├─ attrobject []必须

item 类型: object

├─ idnumber必须
├─ goods_idnumber必须
├─ sign_idstring必须
├─ stocknumber必须
├─ pricestring必须
├─ nostring必须
├─ weightnumber必须
├─ pic_urlstring必须
├─ is_deletenumber必须
├─ attr_listobject []必须

item 类型: object

├─ attr_group_namestring必须
├─ attr_group_idnumber必须
├─ attr_idnumber必须
├─ attr_namestring必须
├─ goods_stocknumber必须
├─ vip_card_appointobject必须
├─ discountnull非必须
├─ is_my_vip_card_goodsnumber非必须
├─ is_vip_card_usernumber非必须
├─ offsetnumber必须

分类列表

基本信息

Path: /cat/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cat_id 是 1 分类id
mch_id 否 0 多商户id
select_cat_id 是 1 cat_list 中选中的 cat_id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须分类列表

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ parent_idstring必须父分类id
├─ namestring必须分类名称
├─ pic_urlstring必须分类图标
├─ sortstring必须分类排序
├─ big_pic_urlstring必须分类大图
├─ advert_picstring必须分类广告图
├─ advert_urlstring必须分类广告链接
├─ statusstring必须是否启用
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_showstring必须是否显示
├─ childobject []必须子分类

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ parent_idstring必须
├─ namestring必须
├─ pic_urlstring必须
├─ sortstring必须
├─ big_pic_urlstring必须
├─ advert_picstring必须
├─ advert_urlstring必须
├─ statusstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_showstring必须
├─ childobject []必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ parent_idstring必须
├─ namestring必须
├─ pic_urlstring必须
├─ sortstring必须
├─ big_pic_urlstring必须
├─ advert_picstring必须
├─ advert_urlstring必须
├─ statusstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ is_showstring必须
├─ page_urlstring必须
├─ activeboolean必须
├─ page_urlstring必须
├─ activeboolean必须
├─ page_urlstring必须
├─ activeboolean必须

商品列表

基本信息

Path: /default/goods-list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
cat_id 否 1 分类id
sort 否 1 自定义排序+时间最新=1 时间最新=2 价格=3 销量=4
sort 否 1 价格正序=1 价格倒叙=0
keyword 否 1 关键字
page 否 1 页码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ mch_idstring必须
├─ namestring必须
├─ pricestring必须
├─ original_pricestring必须原价
├─ cost_pricestring必须成本价
├─ detailstring必须详情
├─ statusstring必须上架状态:0=下架,1=上架
├─ use_attrstring必须是否启用规格
├─ cover_picstring必须商品缩略图
├─ pic_urlobject []必须海报缩略图

item 类型: object

├─ idstring必须
├─ pic_urlstring必须
├─ video_urlstring必须
├─ unitstring必须单位
├─ virtual_salesstring必须虚拟销量
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ sortstring必须
├─ is_quick_shopstring必须1:快速购买 0 不是快速购买
├─ is_sell_wellstring必须1:热销 0:非热销
├─ is_levelstring必须0 启用会员价 1不启用
├─ price_contentstring必须
├─ page_urlstring必须跳转路径
├─ is_negotiablenumber必须0不面议 1面议
├─ salesstring必须销量

省市区

基本信息

Path: /default/district

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须省市区列表

item 类型: object

├─ idnumber必须
├─ namestring必须名称
├─ parent_idnumber必须上级省
├─ levelstring必须类型

枚举: district,city,province

├─ listobject []必须

item 类型: object

├─ idnumber必须
├─ namestring必须
├─ parent_idnumber必须
├─ levelstring必须
├─ listobject []必须

item 类型: object

├─ idnumber必须
├─ namestring必须
├─ parent_idnumber必须
├─ levelstring必须

附件

附件上传

基本信息

Path: /attachment/upload

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type multipart/form-data 是

Body

参数名称 参数类型 是否必须 示例 备注
file file 是

返回数据

名称类型是否必须默认值备注其他信息

余额充值

余额充值设置

基本信息

Path: /api/recharge/setting

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ settingobject非必须
├─ statusstring非必须充值状态 0.关|1开
├─ typestring非必须是否开放自定义金额
├─ bj_pic_urlobject非必须背景图片信息
├─ idstring非必须
├─ storage_idstring非必须
├─ user_idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ sizestring非必须
├─ urlstring非必须
├─ thumb_urlstring非必须
├─ typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attachment_group_idstring非必须
├─ checkedstring非必须
├─ selectedstring非必须
├─ ad_pic_urlobject非必须广告图片信息
├─ idstring非必须
├─ storage_idstring非必须
├─ user_idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ sizestring非必须
├─ urlstring非必须
├─ thumb_urlstring非必须
├─ typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attachment_group_idstring非必须
├─ checkedstring非必须
├─ selectedstring非必须
├─ page_urlstring非必须页面链接
├─ re_pic_urlobject非必须充值图片信息
├─ idstring非必须
├─ storage_idstring非必须
├─ user_idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ sizestring非必须
├─ urlstring非必须
├─ thumb_urlstring非必须
├─ typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ attachment_group_idstring非必须
├─ checkedstring非必须
├─ selectedstring非必须
├─ explainstring非必须备注

余额日志记录

基本信息

Path: /balance/logs

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 否 1 类型 1.收入
page 否 1 分页
date 是 2019-10 日期

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须记录ID
├─ user_idstring必须用户ID
├─ typestring必须类型:1=收入,2=支出
├─ moneystring必须变动金额
├─ descstring必须变动说明
├─ custom_descstring必须该字段前端无用
├─ created_atstring必须

充值

基本信息

Path: /recharge/balance-recharge

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
pay_price text 是 30.11 充值金额
send_price text 是 10 赠送金额

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ pay_idnumber非必须微信支付ID

充值金额列表

基本信息

Path: /recharge/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须
├─ mall_idnumber必须商城ID
├─ namestring必须充值名称
├─ pay_pricestring必须充值金额
├─ send_pricestring必须赠送金额
├─ is_deletenumber必须是否删除
├─ created_atstring必须创建时间
├─ updated_atstring必须更新时间
├─ deleted_atstring必须删除时间

首页

基本信息

Path: /balance/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ settingobject非必须充值设置
├─ statusstring非必须是否开启余额功能0.关闭1.开启
├─ typestring非必须是否开放自定义金额 0.关闭1.开启
├─ bj_pic_urlobject非必须背景图片
├─ idstring非必须
├─ storage_idstring非必须
├─ user_idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ sizestring非必须
├─ urlstring非必须
├─ typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ ad_pic_urlobject非必须广告图片
├─ idstring非必须
├─ storage_idstring非必须
├─ user_idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ sizestring非必须
├─ urlstring非必须
├─ typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ page_urlstring非必须广告图片跳转链接
├─ re_pic_urlobject非必须充值说明图标
├─ idstring非必须
├─ storage_idstring非必须
├─ user_idstring非必须
├─ mall_idstring非必须
├─ namestring非必须
├─ sizestring非必须
├─ urlstring非必须
├─ thumb_urlstring非必须
├─ typestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ checkedstring非必须
├─ explainstring非必须充值说明

合伙人

提现明细

基本信息

Path: /share/cash-list

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
x-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
status 是 状态吗 -1--全部 0--申请中 1--申请通过,待打款 2--已打款 3--驳回
page 是 当前页

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber必须提现记录ID
├─ order_nostring必须提现记录单号
├─ pay_typestring必须提现方式文本
├─ typestring必须提现方式 'auto'--自动打款 wechat--微信 alipay--支付宝 bank--银行 balance--提现到余额
├─ statusnumber必须提现记录状态 0--申请中 1--已通过,待打款 2--已打款 3--已驳回
├─ status_textstring必须提现记录状态文本
├─ userobject必须用户信息
├─ avatarstring非必须用户头像
├─ nicknamestring非必须用户昵称
├─ platformstring非必须用户所属平台 wx--微信
├─ cashobject必须提现信息
├─ pricenumber非必须提现金额
├─ service_chargenumber非必须提现手续费
├─ actual_pricenumber非必须提现实际金额
├─ extraobject必须额外信息
├─ namestring非必须微信昵称/支付宝昵称/开户人
├─ mobilestring非必须微信号/支付宝账号/银行卡号
├─ bank_namestring非必须开户行
├─ timeobject必须时间
├─ created_atstring非必须提交时间
├─ apply_atstring非必须审核时间
├─ remittance_atstring非必须打款时间
├─ reject_atstring非必须驳回时间

合伙人佣金

基本信息

Path: /share/brokerage

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ total_moneystring非必须合伙人佣金
├─ moneystring非必须可提现
├─ un_paynumber非必须待打款
├─ cash_moneynumber非必须已提现
├─ total_cashnumber非必须提现明细

合伙人等级立即升级

基本信息

Path: /api/share/level-up

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ statusnumber非必须是否升级失败

枚举: 0,1

枚举备注: 0--失败 1--成功

├─ level_namestring非必须升级说明
├─ condition_textstring非必须升级条件说明

合伙人订单

基本信息

Path: /share/share-order

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
page 是
status 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ order_nostring必须订单号
├─ nicknamestring必须下单用户昵称
├─ avatarstring必须下单用户头像
├─ statusstring必须订单状态
├─ share_statusobject,string必须合伙人层级
├─ created_atstring必须下单时间
├─ is_salenumber必须是否发放佣金
├─ share_moneynumber必须合伙人金额
├─ goods_listobject []必须商品列表

item 类型: object

├─ idnumber必须商品id
├─ numnumber必须商品数量
├─ namestring必须商品名称
├─ cover_picstring必须商品图片
├─ attr_listobject []必须商品规格

item 类型: object

├─ attr_group_namestring必须
├─ attr_namestring必须

合伙人设置

基本信息

Path: /share/setting

Method: GET

接口描述:

合伙人配置

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
x-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msg string非必须
dataobject非必须
├─ configobject非必须
├─ levelnumber非必须合伙人层级
├─ is_rebatenumber非必须是否内购
├─ price_typenumber非必须佣金类型 1--百分比 2--固定金额
├─ firstnumber非必须一级佣金
├─ secondnumber非必须二级佣金
├─ thirdnumber非必须三级佣金
├─ share_conditionnumber非必须成为合伙人条件 1--无条件(需要审核) 2--申请(需要审核) 3--无需审核
├─ conditionnumber非必须成为下级条件 1--首次链接 2--首次下单 3--首付款
├─ auto_share_valnumber非必须消费满自动成为合伙人
├─ share_goods_statusnumber非必须购买商品成为合伙人 0--关闭 1--任意商品 2--指定商品
├─ share_goods_idnumber非必须指定的商品ID
├─ pay_typestring []非必须提现方式

item 类型: string

├─ 非必须
├─ cash_max_daynumber非必须今日最大可提现额度
├─ min_moneynumber非必须最少提现金额
├─ cash_service_chargenumber非必须提现手续费(%)
├─ agreestring非必须申请协议
├─ contentstring非必须用户须知
├─ pic_url_applystring非必须申请页面图片
├─ pic_url_statusstring非必须审核页面图片
├─ surplusCashnumber非必须今日剩余可提现额度

合伙人首页

基本信息

Path: /share/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ order_moneynumber非必须订单总额
├─ order_money_unnumber非必须未结算佣金
├─ team_countnumber非必须团队人数
├─ total_moneystring非必须合伙人佣金
├─ moneystring非必须可提现佣金
├─ un_paynumber非必须待打款
├─ cash_moneynumber非必须已提现
├─ total_cashnumber非必须提现明细

提现

基本信息

Path: /share/cash

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
x-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
price text 是 提现金额
type text 是 提现方式 auto--自动打款 wechat--微信 alipay--支付宝 bank--银行卡 balance--余额
name text 是 微信昵称/支付宝昵称/开户人
mobile text 是 微信号/支付宝账号/开户号
bank_name text 是 开户行

合伙人等级升级条件

基本信息

Path: /api/share/level

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ condition_typenumber必须升级条件

枚举: 1,2,3

枚举备注: 1--下线人数 2--累计佣金 3--已提现佣金

├─ conditionnumber必须升级数量

申请合伙人

基本信息

Path: /share/apply

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 cc 合伙人名称
mobile text 是 123 合伙人手机号
agree text 是 0

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ namestring必须

申请状态查询

基本信息

Path: /share/apply-status

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ shareobject非必须合伙人信息
├─ statusstring非必须合伙人申请状态0--申请中 1--成功 2--失败

申请状态查询--合伙人等级之后版本

基本信息

Path: /api/share/new-apply-status

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ shareobject非必须合伙人信息
├─ idnumber非必须
├─ mall_idnumber非必须
├─ user_idnumber非必须
├─ namestring非必须
├─ mobilestring非必须
├─ contentnull非必须
├─ levelnumber非必须合伙人等级
├─ level_atstring非必须
├─ statusnumber非必须展示的状态

枚举: 0,1,2,3,4

枚举备注: 0--合伙人申请中 1--已经是合伙人 2--可以申请合伙人 3--条件未满足 4--合伙人申请被拒绝 5--合伙人被删除

├─ orderPricenull非必须单次消费金额
├─ goodsListnull非必须购买指定的商品列表
├─ catListnull非必须购买指定的分类列表

绑定合伙人关系

基本信息

Path: /share/bind-parent

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
parent_id 是 绑定的上级user_id
condition 是 成为下级条件

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

自定义

基本信息

Path: /share/customize

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ codenumber非必须
├─ dataobject非必须
├─ menusobject非必须
├─ moneyobject非必须合伙人佣金
├─ namestring非必须名称(下同)
├─ iconstring非必须图标(下同)
├─ open_typestring非必须跳转方式(下同)
├─ urlstring非必须路径(下同)
├─ telstring非必须
├─ orderobject非必须合伙人订单
├─ namestring非必须
├─ iconstring非必须
├─ open_typestring非必须
├─ urlstring非必须
├─ telstring非必须
├─ cashobject非必须提现明细
├─ namestring非必须
├─ iconstring非必须
├─ open_typestring非必须
├─ urlstring非必须
├─ telstring非必须
├─ teamobject非必须我的团队
├─ namestring非必须
├─ iconstring非必须
├─ open_typestring非必须
├─ urlstring非必须
├─ telstring非必须
├─ qrcodeobject非必须推广二维码
├─ namestring非必须
├─ iconstring非必须
├─ open_typestring非必须
├─ urlstring非必须
├─ telstring非必须
├─ wordsobject非必须
├─ can_be_presentedobject非必须可提现佣金
├─ namestring非必须
├─ defaultstring非必须
├─ already_presentedobject非必须已提现佣金
├─ namestring非必须
├─ defaultstring非必须
├─ parent_nameobject非必须推荐人
├─ namestring非必须
├─ defaultstring非必须
├─ pending_moneyobject非必须待打款佣金
├─ namestring非必须
├─ defaultstring非必须
├─ cashobject非必须提现
├─ namestring非必须
├─ defaultstring非必须
├─ user_instructionsobject非必须用户须知
├─ namestring非必须
├─ defaultstring非必须
├─ apply_cashobject非必须我要提现
├─ namestring非必须
├─ defaultstring非必须
├─ cash_typeobject非必须提现方式
├─ namestring非必须
├─ defaultstring非必须
├─ cash_moneyobject非必须提现金额
├─ namestring非必须
├─ defaultstring非必须
├─ order_money_unobject非必须未结算佣金
├─ namestring非必须
├─ defaultstring非必须
├─ share_nameobject非必须合伙人
├─ namestring非必须
├─ defaultstring非必须
├─ one_shareobject非必须一级合伙人名称
├─ namestring非必须
├─ defaultstring非必须
├─ second_shareobject非必须二级合伙人名称
├─ namestring非必须
├─ defaultstring非必须
├─ three_shareobject非必须三级合伙人名称
├─ namestring非必须
├─ defaultstring非必须

获取团队详情

基本信息

Path: /share/team

Method: GET

接口描述:

合伙人团队详情

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
x-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
status 是 合伙人层级
page 是 列表分页

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idnumber非必须
├─ nicknamestring非必须用户昵称
├─ peopleCountnumber非必须推广人数
├─ orderCountnumber非必须合伙人订单数
├─ orderPricenumber非必须合伙人订单消费金额
├─ avatarstring非必须用户头像
├─ junior_atstring非必须成为下级时间
├─ first_countinteger必须一级人数
├─ second_countinteger必须二级人数
├─ third_countinteger必须三级人数

视频专区

视频列表

基本信息

Path: /video/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 是 1

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ titlestring非必须标题
├─ typestring非必须类型
├─ urlstring非必须视频url
├─ pic_urlstring非必须封面图
├─ contentstring非必须详情
├─ sortstring非必须排序
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ timestring非必须日期格式化

视频播放接口

基本信息

Path: /video/play

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
X-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

Query

参数名称 是否必须 示例 备注
url 是

返回数据

名称类型是否必须默认值备注其他信息

购物车

列表

基本信息

Path: /cart/list

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ user_idstring必须
├─ goods_idstring必须
├─ attrnull必须规格信息
├─ numstring必须
├─ mch_idstring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ deleted_atstring必须
├─ updated_atstring必须
├─ goodsnull必须商品信息

批量删除

基本信息

Path: /cart/delete

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
cart_id_list text 是 "[1,2,3]" 购物车id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

批量编辑

基本信息

Path: /cart/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
list text 是 [{"attr":"67","num":778,"good_id":"10"}] 改动的部分 json

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

购物车添加

基本信息

Path: /cart/add

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是
X-Access-Token 0DBfMLNTV2H_EqWr1fn7zowiROUfwind 是

Body

参数名称 参数类型 是否必须 示例 备注
goods_id text 是 1 商品id
attr text 是 1 规格id
num text 是 1 商品数量

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

user

余额日志记录

基本信息

Path: /api/balance/log-detail

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 1 日志ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ user_idnumber非必须
├─ typenumber非必须
├─ moneystring非必须
├─ descstring非必须
├─ custom_descstring非必须
├─ created_atstring非必须

发送验证码

基本信息

Path: /user/phone-code

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
mobile 是 手机号码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

手机手动绑定

基本信息

Path: /user/phone-empower

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
mobile text 是 手机号码
code text 是 验证码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ mobilestring非必须手机号码

手机绑定

基本信息

Path: /phone/binding

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
code text 是
encryptedData text 是
iv text 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

用户信息

基本信息

Path: /user/user-info

Method: GET

接口描述:

用户信息

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
x-Access-Token FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ nicknamestring非必须用户昵称
├─ mobilestring非必须用户绑定手机号
├─ optionsobject非必须
├─ idnumber非必须
├─ user_idnumber非必须用户id
├─ avatarstring非必须用户头像
├─ integralnumber非必须可用积分
├─ total_integralnumber非必须总积分
├─ balancestring非必须余额
├─ parent_idnumber非必须上级id
├─ is_blacklistnumber非必须是否拉黑
├─ contact_waystring非必须联系方式
├─ remarkstring非必须备注
├─ is_deletenumber非必须
├─ junior_atstring非必须成为下级时间
├─ store_idnumber非必须所属门店
├─ identityobject非必须
├─ parent_namestring非必须上级合伙人昵称
├─ levelNamestring非必须用户会员名称

会员中心

会员专属商品分类列表

基本信息

Path: /api/mall-member/goods-cats

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须分类列表

item 类型: object

├─ idnumber必须分类ID
├─ mall_idnumber必须商品ID
├─ parent_idnumber必须分类父级ID
├─ namestring必须分类名称
├─ pic_urlstring必须分类图标
├─ sortnumber必须分类排序
├─ big_pic_urlstring必须分类大图
├─ advert_picstring必须
├─ advert_urlstring必须
├─ statusnumber必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

会员专属商品列表

基本信息

Path: /api/mall-member/member-goods

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页
cats_id 否 1 分类ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须会员商品列表

item 类型: object

├─ idnumber非必须商品ID
├─ mall_idnumber非必须商城ID
├─ mch_idnumber非必须多商户ID
├─ namestring非必须商品名称
├─ pricestring非必须商品价格
├─ original_pricestring非必须商品原价
├─ cost_pricestring非必须
├─ detailstring非必须
├─ statusnumber非必须
├─ use_attrnumber非必须
├─ attr_groupsstring非必须
├─ cover_picstring非必须商品大图
├─ pic_urlstring非必须商品图片
├─ video_urlstring非必须
├─ unitstring非必须
├─ virtual_salesnumber非必须
├─ sortnumber非必须
├─ is_quick_shopnumber非必须
├─ is_sell_wellnumber非必须
├─ is_levelnumber非必须
├─ confine_countnumber非必须
├─ give_integralnumber非必须
├─ give_integral_typenumber非必须
├─ forehead_integralnumber非必须
├─ forehead_integral_typenumber非必须
├─ accumulativenumber非必须
├─ is_negotiablenumber非必须
├─ freight_idnumber非必须
├─ piecesstring非必须
├─ foreheadstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletenumber非必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

会员优惠券列表

基本信息

Path: /api/mall-member/member-coupon

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须优惠券列表

item 类型: object

├─ idnumber必须优惠券ID
├─ mall_idnumber必须商城ID
├─ namestring必须优惠券名称
├─ typenumber必须优惠券类型
├─ discountstring必须优惠券折扣
├─ pic_urlnumber必须优惠券图标
├─ descstring必须优惠券备注、描述
├─ min_pricestring必须最低消费金额
├─ sub_pricestring必须优惠金额
├─ total_countnumber必须发放总数量
├─ is_joinnumber必须是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sortnumber必须排序
├─ expire_typenumber必须到期类型:1=领取后N天过期,2=指定有效期
├─ expire_daynumber必须有效天数,expire_type=1时
├─ begin_timestring必须有效期开始时间
├─ end_timestring必须有效期结束时间
├─ appoint_typenumber必须1 指定商品 2 指定商品 3全部
├─ rulestring必须使用说明
├─ is_deletenumber必须
├─ deleted_atstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

会员列表

基本信息

Path: /api/mall-member/all-member

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 否 1 分页

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ listobject []非必须会员列表

item 类型: object

├─ idstring必须会员ID
├─ mall_idstring必须商城ID
├─ levelstring必须会员等级
├─ namestring必须会员名称
├─ auto_updatestring必须满金额是否自动升级0.否1.是
├─ moneystring必须升级会员所需消费金额
├─ discountstring必须会员折扣
├─ statusstring必须会员状态
├─ pic_urlstring必须会员图标
├─ is_purchasestring必须是否可购买0.否1.是
├─ pricestring必须会员购买价格
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletestring必须
├─ rightsobject []必须会员权益列表

item 类型: object

├─ idstring必须权益ID
├─ member_idstring必须关联会员ID
├─ titlestring必须权益标题
├─ contentstring必须权益内容
├─ pic_urlstring必须权益图标
├─ is_deletestring必须
├─ paginationobject非必须
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

会员详情

基本信息

Path: /api/mall-member/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
api/mall-member/detail 是 2 会员ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ detailobject非必须会员详情
├─ idstring非必须
├─ mall_idstring非必须
├─ levelstring非必须
├─ namestring非必须
├─ auto_updatestring非必须累计金额是否自动升级0.否1.是
├─ moneystring非必须
├─ discountstring非必须
├─ statusstring非必须
├─ pic_urlstring非必须
├─ is_purchasestring非必须是否可购买0.否1.是
├─ pricestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ rightsobject []非必须

item 类型: object

├─ idstring必须
├─ member_idstring必须
├─ titlestring必须
├─ contentstring必须
├─ pic_urlstring必须
├─ is_deletestring必须

购买会员

基本信息

Path: /mall-member/purchase-member

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
member_level text 是 5 购买会员的会员等级

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ pay_idnumber非必须支付ID

首页

基本信息

Path: /api/mall-member/index

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ consumption_moneynumber非必须用户总消费金额
├─ mall_memberobject非必须用户当前会员信息
├─ idstring非必须会员ID
├─ mall_idstring非必须商城ID
├─ levelstring非必须会员等级
├─ namestring非必须会员名称
├─ moneystring非必须消费此金额可升级会员
├─ discountstring非必须会员折扣
├─ statusstring非必须会员状态
├─ pic_urlstring非必须会员图标
├─ pricestring非必须会员购买价格
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ rightsobject []非必须会员权益列表

item 类型: object

├─ idstring必须权益ID
├─ member_idstring必须会员ID
├─ titlestring必须权益标题
├─ contentstring必须权益内容
├─ pic_urlstring必须权益图标
├─ is_deletestring必须
├─ next_mall_memberobject []非必须下一级会员列表

item 类型: object

├─ idstring非必须
├─ mall_idstring非必须
├─ levelstring非必须
├─ namestring非必须
├─ moneystring非必须
├─ discountstring非必须
├─ statusstring非必须
├─ pic_urlstring非必须
├─ pricestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ is_deletestring非必须
├─ rightsobject []非必须

item 类型: object

├─ idstring非必须
├─ member_idstring非必须
├─ titlestring非必须
├─ contentstring非必须
├─ pic_urlstring非必须
├─ is_deletestring非必须
├─ member_goodsobject []非必须会员专属商品列表

item 类型: object

├─ idnumber必须商品ID
├─ mall_idnumber必须商城ID
├─ mch_idnumber必须多商户ID
├─ namestring必须商品名称
├─ pricestring必须商品价格
├─ original_pricestring必须商品原价
├─ cost_pricestring必须
├─ detailstring必须
├─ statusnumber必须
├─ use_attrnumber必须
├─ attr_groupsstring必须
├─ cover_picstring必须
├─ pic_urlstring必须商品图片
├─ video_urlstring必须
├─ unitstring必须
├─ virtual_salesnumber必须
├─ sortnumber必须
├─ is_quick_shopnumber必须
├─ is_sell_wellnumber必须
├─ is_levelnumber必须
├─ confine_countnumber必须
├─ give_integralnumber必须
├─ give_integral_typenumber必须
├─ forehead_integralnumber必须
├─ forehead_integral_typenumber必须
├─ accumulativenumber必须
├─ is_negotiablenumber必须
├─ freight_idnumber必须
├─ piecesstring必须
├─ foreheadstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ is_deletenumber必须
├─ member_couponsobject []非必须会员专属优惠券列表

item 类型: object

├─ idnumber必须优惠券ID
├─ mall_idnumber必须商城ID
├─ namestring必须优惠券名称
├─ typenumber必须优惠券类型
├─ discountstring必须折扣
├─ pic_urlnumber必须图标
├─ descstring必须备注、描述
├─ min_pricestring必须最低消费金额
├─ sub_pricestring必须优惠金额
├─ total_countnumber必须发放总数量
├─ is_joinnumber必须是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sortnumber必须排序按升序排列
├─ expire_typenumber必须到期类型:1=领取后N天过期,2=指定有效期
├─ expire_daynumber必须有效天数,expire_type=1时
├─ begin_timestring必须有效期开始时间
├─ end_timestring必须有效期结束时间
├─ appoint_typenumber必须1 指定商品 2 指定商品 3全部
├─ rulestring必须使用说明
├─ is_deletenumber必须
├─ deleted_atstring必须
├─ created_atstring必须
├─ updated_atstring必须

专题

专题分类

基本信息

Path: /topic/type

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ namestring必须分类名称
├─ sortstring必须排序
├─ is_deletestring必须
├─ created_atstring必须
├─ deleted_atstring必须
├─ updated_atstring必须

专题列表

基本信息

Path: /topic/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
type 是 0 专题分类id 0:全部 -1:精选
page 是 1 分页

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ typestring必须分类类型
├─ titlestring必须标题
├─ sub_titlestring必须副标题
├─ contentstring必须详情
├─ layoutstring必须布局方式:0=小图,1=大图模式 3多图
├─ sortstring必须排序
├─ cover_picstring必须封面图
├─ read_countstring必须阅读量
├─ agree_countstring必须点赞数(未用)
├─ virtual_read_countstring必须虚拟阅读量
├─ virtual_agree_countstring必须虚拟点赞数(未用)
├─ virtual_favorite_countstring必须虚拟收藏量
├─ qrcode_picstring必须海报图
├─ is_chosenstring必须是否精选 0不精选 1精选
├─ is_deletestring必须
├─ deleted_atstring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ goods_countstring必须商品数

专题详情

基本信息

Path: /topic/detail

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是 3 文章id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ idnumber非必须
├─ mall_idnumber非必须
├─ typenumber非必须分类类型id
├─ titlestring非必须标题
├─ sub_titlestring非必须副标题
├─ contentstring非必须详情
├─ layoutnumber非必须布局方式:0=小图,1=大图模式 2=多图
├─ sortnumber非必须排序
├─ cover_pic_idnumber非必须图片id
├─ read_countstring非必须阅读量
├─ agree_countnumber非必须点赞数
├─ virtual_read_countnumber非必须虚拟阅读量
├─ virtual_agree_countnumber非必须虚拟点赞数(未用)
├─ virtual_favorite_countnumber非必须虚拟收藏量
├─ qrcode_pic_idnumber非必须
├─ is_chosennumber非必须是否精选
├─ is_deletenumber非必须
├─ deleted_atstring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ goods_countstring非必须商品数
├─ is_favoritestring非必须是否收藏0不收藏 1收藏

文章收藏

基本信息

Path: /topic/favorite

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 3 文章id
is_favorite text 是 no_love no_love:不喜欢 love 喜欢

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

小票打印后台

列表

基本信息

Path: /printer/index

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page_size 是 1 10

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ typestring必须打印机品牌
├─ namestring必须打印机名称
├─ settingstring必须打印机设置
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ selectobject []非必须打印机选择

item 类型: object

├─ valuestring必须
├─ labelstring必须
├─ paginationobject非必须页码
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

删除

基本信息

Path: /printer/destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 打印机id

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须

编辑数据

基本信息

Path: /printer/edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 是

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ typestring非必须打印机类型
├─ namestring非必须打印机名称
├─ settingobject非必须打印机配置相关
├─ machine_codestring非必须
├─ keystring非必须
├─ client_idstring非必须
├─ client_keystring非必须
├─ urlstring非必须
├─ timestring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ selectobject []非必须打印机选择

item 类型: object

├─ valuestring必须
├─ labelstring必须

编辑提交

基本信息

Path: /printer/edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 飞蛾 打印机名称
type text 是 360-kdt2 打印机类型360-kdt2,yilianyun-k4,feie,gainscha-gp
setting text 是 {key:123} 打印机配置 数组
id text 否 1 id存在 表示编辑

返回数据

名称类型是否必须默认值备注其他信息

打印设置列表

基本信息

Path: /printer/setting

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page_size 是 10

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject []非必须

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ printer_idstring必须打印机id
├─ block_idstring必须模板id
├─ statusstring必须是否启用
├─ is_attrstring必须是否使用规格
├─ typestring必须打印级配置
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须
├─ printerobject必须打印机
├─ idstring非必须
├─ mall_idstring非必须
├─ typestring非必须
├─ namestring非必须打印机名称
├─ settingstring非必须
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ paginationobject非必须页面
├─ defaultPageSizenumber非必须
├─ pageSizenumber非必须
├─ total_countnumber非必须
├─ page_countnumber非必须
├─ current_pagenumber非必须
├─ pageParamstring非必须
├─ pageSizeParamstring非必须
├─ forcePageParamboolean非必须
├─ routenull非必须
├─ paramsnull非必须
├─ urlManagernull非必须
├─ validatePageboolean非必须
├─ totalCountnumber非必须
├─ pageSizeLimitnumber []非必须

item 类型: number

├─ 非必须

打印设置

基本信息

Path: /printer/setting-edit

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 否 1 打印设置ID

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ listobject非必须
├─ idstring非必须
├─ mall_idstring非必须
├─ printer_idstring非必须打印机id
├─ block_idstring非必须
├─ statusstring非必须是否启用
├─ is_attrstring非必须是否使用规格
├─ typenumber非必须打印机配置
├─ is_deletestring非必须
├─ created_atstring非必须
├─ updated_atstring非必须
├─ deleted_atstring非必须
├─ selectobject []非必须下拉框

item 类型: object

├─ idstring必须
├─ mall_idstring必须
├─ typestring必须
├─ namestring必须
├─ settingstring必须
├─ is_deletestring必须
├─ created_atstring必须
├─ updated_atstring必须
├─ deleted_atstring必须

打印设置提交

基本信息

Path: /printer/setting-edit

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
printer_id text 是 1 打印机id
is_attr text 是 1 是否使用规格
block_id text 否 1 模板id
type text 是 {"order":"1","pay":"1","confirm":"1"} 打印配置order:下单 pay付款 confirm 确认收货打印
status text 是 0 是否启用

返回数据

名称类型是否必须默认值备注其他信息

打印设置删除

基本信息

Path: /printer/setting-destroy

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id text 是 1 打印设置id

Build by YMFE.